List users

get

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

string

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

external_id

string

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

string

Email of the user you're looking for

limit

integer

1 to 100

Defaults to 30

Maximum number of items to return.

order_by

string

enum

Defaults to name:asc

Attribute used to order users.

roles

array of strings

A list of roles to filter users.

roles

string

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

available_first

boolean

Defaults to false

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

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

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

application/json

200A list of users.