---
title: "List customers"
method: GET
path: "/customers/"
tags: ["Billing"]
---

# List customers

`GET /customers/`

Returns a paginated list of customers in the workspace.

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `country` string
- `email` string
- `name` string
- `tax_id` string
- `created` string, date-time
- `subscriptions` string
- `sources` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated customer list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Customer[], required — The items in the current page.
    - `id` string
    - `name` string, required
    - `address` string, required
    - `country` Country, required
      - `id` string
      - `name` string
      - `code` string
      - `has_regulation` boolean
      - `currencies` string[]
    - `state` State, required
      - `id` integer
      - `name` string
      - `country` string
    - `currency` string — ISO currency code (e.g. CLP, USD).
    - `email` string, email, nullable
    - `phone` string, nullable
    - `website` string, uri, nullable
    - `zip_code` string, nullable
    - `manager` string, nullable — Account manager name (free text).
    - `reference` string, nullable — External reference for the customer.
    - `tax_id` string, nullable — Tax identifier. Required when the customer's country has tax regulation (e.g. Chile RUT, Mexico RFC, Colombia NIT) and matches the account's country.
    - `tax_settings` object — Country-specific tax configuration. Schema and required keys depend on the tax agency of the customer's country.
    - `metadata` object — Arbitrary key/value metadata. Filterable via `?metadata__key=value`.
    - `send_invoices` boolean — Whether to email invoices to the customer.
    - `send_collections` boolean — Whether to email collection reminders to the customer.
    - `send_vouchers` boolean — Whether to email payment receipts to the customer.
    - `status` 'active' | 'archived' | 'pending'
    - `contacts` Contact[]
      - `id` string
      - `customer` string, nullable — Customer ID this contact belongs to.
      - `orgunit` string, nullable — Organisation unit ID. Optional sub-grouping inside a customer.
      - `name` string, required
      - `email` string, email, required
      - `phone` string, nullable
      - `invoicing` boolean — Whether this contact receives invoice emails.
      - `collections` boolean — Whether this contact receives collection reminders.
      - `created` string, date-time
      - `updated` string, date-time
    - `sources` string[] — IDs of reusable payment sources currently chargeable or pending.
    - `aggregations` Aggregations
      - `sales` number — Total finalized + paid sales for the customer.
      - `sales_current_period` number — Sales finalized within the current calendar month.
      - `balance` number — Outstanding balance across non-succeeded payments on finalized/pending invoices.
    - `test_mode` boolean
    - `created` string, date-time
    - `updated` string, date-time

## Other responses

- `401` — Authentication credentials missing or invalid.
- `403` — The caller is authenticated but not allowed to access this resource.

---

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