Skip to main content
GET
/
customer
cURL
curl --request GET \
  --url https://api.slash.com/customer \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": {},
      "customMetadata": {}
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

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:legalEntityId
string

Filter customers by legal entity ID. Required if authenticating via bearer token with access to multiple legal entities.

​
filter:name
string

Filter customers by name (partial match).

​
filter:status
enum<string>

Filter customers by status.

Available options:
active,
archived

Response

OK

​
items
Customer · object[]
required
​
metadata
PaginationResponse · object

Response sent when requesting a list of data