Skip to main content
GET
/
card-group
cURL
curl --request GET \
  --url https://api.slash.com/card-group \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "virtualAccountId": "<string>",
      "spendingConstraint": {
        "merchantCategoryRule": {
          "merchantCategories": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "merchantRule": {
          "merchants": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "spendingRule": {
          "utilizationLimit": {
            "limitAmount": {
              "amountCents": 123
            },
            "preset": "daily",
            "timezone": "<string>",
            "startDate": "<string>"
          },
          "utilizationLimitV2": [
            {
              "limitAmount": {
                "amountCents": 123
              },
              "preset": "daily",
              "timezone": "<string>",
              "startDate": "<string>"
            }
          ],
          "transactionSizeLimit": {
            "minimum": {
              "amountCents": 123
            },
            "maximum": {
              "amountCents": 123
            }
          }
        },
        "countryRule": {
          "countries": [
            "<string>"
          ],
          "restriction": "allowlist"
        },
        "merchantCategoryCodeRule": {
          "merchantCategoryCodes": [
            "<string>"
          ],
          "restriction": "allowlist"
        }
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.slash.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Query Parameters

cursor
string

A cursor string to fetch the next page of results

filter:name
string

Pass in a name to filter for card groups with a matching name.

filter:virtualAccountId
string

Pass in a virtual account ID to filter for card groups under a specific virtual account.

filter:status
enum<string>

Filter card groups by status. Defaults to 'active' if not provided.

Available options:
active,
archived

Response

OK

items
CardGroup · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data