Skip to main content
GET
/
v1
/
customers
curl --location --request GET 'https://api.stateset.com/v1/customers?limit=20&offset=0&order_direction=desc' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>'

{
  "customers": [
    {
      "sso_id": "1234-5678-9012-3456",
      "email": "jane.doe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "phone": "+1-555-123-4567",
      "stripe_customer_id": "cus_1234567890",
      "activationDate": "2024-01-15T00:00:00.000Z",
      "timestamp": "2024-06-01T12:30:00.000Z"
    },
    {
      "sso_id": "9876-5432-1098-7654",
      "email": "john.smith@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "phone": "+1-555-987-6543",
      "stripe_customer_id": "cus_0987654321",
      "activationDate": "2024-02-20T00:00:00.000Z",
      "timestamp": "2024-05-28T09:15:00.000Z"
    }
  ],
  "total_count": 142,
  "has_more": true
}
Returns a paginated array of customer objects. Use query parameters to filter, sort, and paginate results.

​
Query Parameters

​
limit
integer
default:"20"
Maximum number of customers to return per page. Range: 1-100.Example: 50
​
offset
integer
default:"0"
Number of records to skip for pagination.Example: 20
​
order_direction
string
default:"desc"
Sort direction for results. Options: asc, desc.
​
email
string
Filter customers by email address (exact match).Example: jane.doe@example.com
​
created_after
string
Filter customers created after this ISO 8601 date.Example: 2024-01-01T00:00:00.000Z

​
Response

​
customers
array
Array of customer objects.
​
total_count
integer
Total number of customers matching the query.
​
has_more
boolean
Whether there are more results beyond the current page.
curl --location --request GET 'https://api.stateset.com/v1/customers?limit=20&offset=0&order_direction=desc' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>'

{
  "customers": [
    {
      "sso_id": "1234-5678-9012-3456",
      "email": "jane.doe@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "phone": "+1-555-123-4567",
      "stripe_customer_id": "cus_1234567890",
      "activationDate": "2024-01-15T00:00:00.000Z",
      "timestamp": "2024-06-01T12:30:00.000Z"
    },
    {
      "sso_id": "9876-5432-1098-7654",
      "email": "john.smith@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "phone": "+1-555-987-6543",
      "stripe_customer_id": "cus_0987654321",
      "activationDate": "2024-02-20T00:00:00.000Z",
      "timestamp": "2024-05-28T09:15:00.000Z"
    }
  ],
  "total_count": 142,
  "has_more": true
}