Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Users

List users

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

get/api/users

Query parameters

cursorstring
Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

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

external_idstring
Example:user-hf329f

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

emailstring
Example:steve@example.com

Email of the user you're looking for

limitinteger

Maximum number of items to return.

order_by'created_datetime:asc' | 'created_datetime:desc' | 'name:asc' | 'name:desc' | 'email:asc' | 'email:desc' | 'role.name:asc' | 'role.name:desc'

Attribute used to order users.

rolesstring[]

A list of roles to filter users.

searchstring

Retrieve users where either the name or email address matches the specified search term.

available_firstboolean

When true, available users are returned first, followed by non-available users.

Response

A list of users.

idinteger

ID of the user.

activeboolean

Whether the user can log in.

biostring

Short biography of the user.

created_datetimestring date-time

When the user was created.

countrystring ISO 3166-1 alpha-2

Country of the user

deactivated_datetimestring date-time

When the user was deactivated.

emailstring email

Email address of the user. password_confirmation field must be provided to change the email.

external_idstring

ID of the user 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 user.

lastnamestring

Last name of the user.

languagestring

Language of the user.

namestring

Full name of the user.

timezonestring

Timezone of the user.

updated_datetimestring date-time

When the user was last updated.

client_idstring

Service account associated application ID.

Example response

[
  {
    "id": 3924,
    "active": true,
    "bio": "Full stack developer at Gorgias",
    "created_datetime": "2019-04-13T03:27:56.973873",
    "country": "FR",
    "email": "steve@company.com",
    "external_id": "user-84203241",
    "firstname": "Steve",
    "lastname": "Frazeli",
    "language": "fr",
    "meta": {
      "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
      "position": "engineer"
    },
    "name": "Steve Frazelli",
    "role": {
      "name": "admin"
    },
    "timezone": "US/Pacific",
    "updated_datetime": "2019-09-25T06:18:22.839271",
    "client_id": "74ef4b177"
  }
]