List Customers
gorgias_list_customersList customers with pagination and filters for email, name, language, timezone, channel, or external ID.
Instructions
GET /api/customers — List customers (paginated, default order: created_datetime:desc). Supports filtering by email, external ID, name, language, timezone, view, channel type, and channel address.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Filter by the full name of the customer. | |
| No | Filter by the primary email address of the customer. | ||
| limit | No | Maximum number of customers to return per page (default: 30, max: 100). | |
| cursor | No | Pagination cursor from a previous response. Omit to retrieve the first page. | |
| view_id | No | Filter by saved view ID. | |
| language | No | Filter by the customer's preferred language (ISO 639-1 format, e.g. 'fr', 'en'). | |
| order_by | No | Attribute used to order customers (default: 'created_datetime:desc'). | |
| timezone | No | Filter by the customer's preferred timezone (IANA timezone name, e.g. 'America/New_York'). | |
| external_id | No | Filter by the customer's ID in a foreign system (Stripe, Aircall, etc.). | |
| channel_type | No | Filter by customer channel type (e.g. 'email', 'phone', 'sms', 'chat', 'facebook'). | |
| channel_address | No | Filter by exact channel address. Typically used together with channel_type. |