---
title: "Lists all customers"
method: GET
path: "/customers"
tags: ["Customers"]
---

# Lists all customers

`GET /customers`

Returns customers for accounts receivable with pagination and optional search or external-reference filters.

## Query parameters

- `limit` integer
- `cursor` string — If defined, a cursor to retrieve the next page.
- `search` string
- `external_reference_id` string
- `external_reference_type` string
- `updated.gt` string, date-time
- `sort_by` 'created' | 'updated'

## Response `200`

OK

- object
  - `customers` Customer[], required
    - `id` string, uuid, required
    - `updated_at` string, date-time, required — ISO 8601 timestamp in UTC timezone (must end with 'Z')
    - `name` string, required
    - `name_on_invoice` string
    - `address` Address
      - `line1` string, required
      - `line2` string
      - `city` string, required
      - `state` string, required — State or province code (e.g. 'TN', 'CA' for US; 'ON' for Canada). Required when address is provided.
      - `zip_code` string, required
      - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
    - `shipping_address` Address
      - `line1` string, required
      - `line2` string
      - `city` string, required
      - `state` string, required — State or province code (e.g. 'TN', 'CA' for US; 'ON' for Canada). Required when address is provided.
      - `zip_code` string, required
      - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
    - `emails` CustomerEmail[]
      - `email` string, required
      - `type` 'MAIN_SENDER' | 'CC' | 'BCC', required
    - `external_references` ExternalReference[]
      - `type` string, required
      - `id` string, required
      - `url` string, uri
    - `payment_terms` integer
    - `send_invoices_automatically` boolean — When set to true, invoices for this customer will be automatically sent via email on the invoice date.
    - `send_payment_reminders` boolean — When set to true, an email will be sent to customers periodically if they have not paid an invoice.
    - `fields` object[]
      - `field_id` string, uuid, required
      - `field_value_id` string, uuid, required
  - `pagination` Pagination
    - `next_cursor` string — If defined, a cursor to retrieve the next page.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/rillet/apis/rillet-accounting-api.md) · [All operations](https://skmtc.net/rillet/apis/rillet-accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rillet/rillet-accounting-api/versions/a2ab794dd5f2/schema)