Customers

List customers

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

get/api/customers

Request

Base URL
https://your-domain.gorgias.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/gorgias/apis/gorgias-rest-api/docs/api/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

cursorstring

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

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

emailstring email nullable

Example:john@example.com

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

external_idstring nullable

Example:customer-84203241

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

language'aa' | 'ab' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'as' | 'av' | 'ae' | 'ay' | 'az' | 'ba' | 'bm' | 'eu' | 'be' | 'bn' | 'bh' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'ka' | 'de' | 'gd' | 'ga' | 'gl' | 'gv' | 'el' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hr' | 'hu' | 'ig' | 'is' | 'io' | 'ii' | 'iu' | 'ie' | 'ia' | 'id' | 'ik' | 'it' | 'jv' | 'ja' | 'kl' | 'kn' | 'ks' | 'kr' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lb' | 'lu' | 'lg' | 'mk' | 'mh' | 'ml' | 'mi' | 'mr' | 'ms' | 'mg' | 'mt' | 'mn' | 'na' | 'nv' | 'nr' | 'nd' | 'ng' | 'ne' | 'nn' | 'nb' | 'no' | 'ny' | 'oc' | 'oj' | 'or' | 'om' | 'os' | 'pa' | 'fa' | 'pi' | 'pl' | 'pt' | 'ps' | 'qu' | 'rc' | 'rm' | 'ro' | 'rn' | 'ru' | 'sg' | 'sa' | 'si' | 'sk' | 'sl' | 'se' | 'sm' | 'sn' | 'sd' | 'so' | 'st' | 'es' | 'sc' | 'sr' | 'ss' | 'su' | 'sw' | 'sv' | 'ty' | 'ta' | 'tt' | 'te' | 'tg' | 'tl' | 'th' | 'bo' | 'ti' | 'to' | 'tn' | 'ts' | 'tk' | 'tr' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'cy' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu' nullable

Example:fr

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

limitinteger

Maximum number of customers to return.

namestring nullable

Example:John Smith

Full name of the customer you're looking for.

order_by'created_datetime:asc' | 'created_datetime:desc' | 'updated_datetime:asc' | 'updated_datetime:desc'

Attribute used to order customers.

Example:UTC

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

view_idinteger

Example:4

ID of a view to filter customers by.

channel_typestring

Example:instagram

Filter customers by their customer channel types.

channel_addressstring

Example:@therock

Filter customers by their customer channel addresses.

Response

A list of customers.

idinteger

ID of the customer.

created_datetimestring date-time nullable

When the customer was created.

emailstring email nullable

Primary email address of the customer.

external_idstring nullable

ID of the customer in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish.

firstnamestring

First name of the customer.

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

lastnamestring

Last name of the customer.

namestring nullable

Full name of the customer.

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

updated_datetimestring date-time nullable

When the customer was last updated.

Example response

[
  {
    "id": 3924,
    "created_datetime": "2019-04-13T03:27:56.973873",
    "email": "john@example.com",
    "external_id": "customer-84203241",
    "firstname": "John",
    "language": "fr",
    "lastname": "Smith",
    "name": "John Smith",
    "timezone": "UTC",
    "updated_datetime": "2019-09-25T06:18:22.839271"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.