Skip to main content

Customers

Read-only access to the organization customer directory.

List customers

Auth: Bearer API key
OpenAPI operationId: listCustomers

Query parameters

Validated by publicCustomersQuerySchema.

Response

Field set mirrors the public projection of the customer mapper (optional fields may be omitted when empty). Schema reference: publicCustomerSchema.

Filters and scope

Example

Errors

See Errors.

Not available on public v1

  • GET /customers/:id
  • POST / PATCH / DELETE customers
  • Import/export CSV via API key