---
title: "List customers"
method: GET
path: "/api/v1/customers"
tags: ["Customers"]
---

# List 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`

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

Required scopes: `read customers`

## Query parameters

- `page` integer
- `page_size` integer
- `created_after` string, date-time
- `created_before` string, date-time
- `modified_after` string, date-time
- `modified_before` string, date-time
- `subscribed` boolean

## Response `200`

Successful response

- object
  - `next` string, nullable: URL for the next page of results
  - `previous` string, nullable: URL for the previous page of results
  - `count` integer: Total number of customers matching the query
  - `customers` object[]
    - `id` integer
    - `external_id` string
    - `name` string
    - `email` string
    - `company` string
    - `language` string
    - `tags` string[]
    - `custom_attributes` object
    - `created` string, date-time
    - `modified` string, date-time
    - `subscribed` boolean

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)