List customers

get

https://{domain}.gorgias.com/api/customers

List customers, paginated, and ordered by their name (alphabetical order).

Query Params

cursor

string

Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned.

string | null

Primary email address of the customer you're looking for.

external_id

string | null

ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for.

language

string | null

enum

The customer's preferred language (format: ISO_639-1) to filter with.

limit

integer

1 to 100

Defaults to 30

Maximum number of customers to return.

name

string | null

Full name of the customer you're looking for.

order_by

string

enum

Defaults to created_datetime:desc

Attribute used to order customers.

Allowed:

timezone

string | null

enum

The customer's preferred timezone (format: IANA timezone name).

view_id

integer

≥ 1

ID of a view to filter customers by.

channel_type

string

Filter customers by their customer channel types.

channel_address

string

length ≤ 320

Filter customers by their customer channel addresses.

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of customers.