List Users

List users

GET/api/users

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the List Users action (under Users).
Fill in the fields below, then reference the result from later steps as {{listUsers.response.data}}.

cursorstring

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

external_idstring

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

emailstring

Email of the user you're looking for

limitinteger

Maximum number of items to return.

Default 30

order_bystring

Attribute used to order users.

One ofcreated_datetime:asccreated_datetime:descname:ascname:descemail:ascemail:descrole.name:ascrole.name:descDefault "name:asc"

rolesarray<string>

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.

Default false

Returns 200 with a array<object>. Read it in later steps with {{listUsers.response.data.<field>}}.

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?