Customers

List customers

Get a paginated list of customers with optional filtering by creation/modification dates and subscription status.

Required scopes: read customers

get/api/v1/customers

Request

Base URL: https://api.simplesat.io
URL: https://api.simplesat.io/api/v1/customers
Auth: API key in header X-Simplesat-Token

Query parameters

pageinteger

The page number to retrieve

page_sizeinteger

The number of records per page

created_afterstring date-time

Example:2025-01-01T00:00:00Z

Filter customers created after this date (ISO 8601 format)

created_beforestring date-time

Example:2025-12-31T23:59:59Z

Filter customers created before this date (ISO 8601 format)

modified_afterstring date-time

Example:2025-01-01T00:00:00Z

Filter customers modified after this date (ISO 8601 format)

modified_beforestring date-time

Example:2025-12-31T23:59:59Z

Filter customers modified before this date (ISO 8601 format)

subscribedboolean

Example:true

Filter customers by subscription status

Response

Successful response

nextstring nullable

URL for the next page of results

previousstring nullable

URL for the previous page of results

countinteger

Total number of customers matching the query

Example response

{
  "next": "https://api.simplesat.io/api/v1/customers?page=2&page_size=50",
  "count": 1,
  "customers": [
    {
      "id": 1,
      "external_id": "1",
      "name": "Tester McTestFace",
      "email": "tester@simplesat.io",
      "company": "Simplesat",
      "language": "en",
      "tags": [
        "tag1",
        "tag2"
      ],
      "custom_attributes": {
        "Country": "United States",
        "City": "San Francisco",
        "Channels": [
          "Web",
          "Mobile App"
        ]
      },
      "created": "2025-01-01T00:00:00.000000Z",
      "modified": "2025-09-26T10:28:57.000000Z",
      "subscribed": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.