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>",
      "status": "active",
      "phone": "<string>",
      "address": {},
      "customMetadata": {}
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Authentication from public API requests

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