curl --request GET \
--url 'https://api.stateset.com/api/v1/customers' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"customers": [
{
"accepts_marketing": true,
"created_at": "2026-08-31T14:22:05Z",
"email": "ada.lovelace@example.com",
"first_name": "Ada",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"last_name": "Lovelace",
"phone": "+1 415 555 0142",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"total": 102
}
List customers
List of customers
GET
/
api
/
v1
/
customers
curl --request GET \
--url 'https://api.stateset.com/api/v1/customers' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"customers": [
{
"accepts_marketing": true,
"created_at": "2026-08-31T14:22:05Z",
"email": "ada.lovelace@example.com",
"first_name": "Ada",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"last_name": "Lovelace",
"phone": "+1 415 555 0142",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"total": 102
}
Query parameters
integer (int32)
Maximum number of results to return (default: 50).
integer (int32)
Number of results to skip (default: 0). Ignored when
after cursor is set.string
Cursor for keyset pagination (opaque token from
next_cursor).string
Filter by email address (exact match).
string
Filter by customer status (active, inactive, deleted).
string
Filter by tag.
boolean
Filter by marketing opt-in.
Response
CustomerListResponse
CustomerResponse[]
required
boolean
required
Whether more results are available after this page.
integer (int32)
required
string,null
Opaque cursor for fetching the next page (keyset pagination).
integer (int32)
required
integer
required
Status codes
| Code | Meaning |
|---|---|
200 | List of customers |
400 | Invalid filter parameter |
curl --request GET \
--url 'https://api.stateset.com/api/v1/customers' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"customers": [
{
"accepts_marketing": true,
"created_at": "2026-08-31T14:22:05Z",
"email": "ada.lovelace@example.com",
"first_name": "Ada",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"last_name": "Lovelace",
"phone": "+1 415 555 0142",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"total": 102
}
Last modified on August 31, 2026