Users represent people working for your company. They can be support agents, support specialists, support managers, directors, etc... Users are distinguished by their role.

User properties

id

integer

ID of the user.

active

boolean

Whether the user can log in.

bio

string

Short biography of the user.

created_datetime

ISO 8601 datetime

When the user was created.

country

ISO 3166-1 alpha-2

Country of the user

deactivated_datetime

ISO 8601 datetime

When the user was deactivated.

email

email

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

external_id

string

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.

firstname

string

First name of the user.

lastname

string

Last name of the user.

language

string

Language of the user.

meta

object

Data associated with the user. You can use this field to store structured information (key-value data) about the user.

name

string

Full name of the user.

role

object

The role of the user.

timezone

string

Timezone of the user.

updated_datetime

ISO 8601 datetime

When the user was last updated.

client_id

string

Service account associated application ID.

User example object

{
  "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": {
    "profile_picture_url": "https://config.gorgi.us/3850e14d-c07f-4e9c-8760-9d"
  },
  "name": "Steve Frazelli",
  "role": {
    "name": "admin"
  },
  "timezone": "US/Pacific",
  "updated_datetime": "2019-09-25T06:18:22.839271",
  "client_id": "74ef4b177"
}