API Reference

The User object

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

integer

ID of the user.

boolean

Whether the user can log in.

string

Short biography of the user.

ISO 8601 datetime

When the user was created.

ISO 3166-1 alpha-2

Country of the user

ISO 8601 datetime

When the user was deactivated.

email

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

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.

string

First name of the user.

string

Last name of the user.

string

Language of the user.

object

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

string

Full name of the user.

object

The role of the user.

string

Timezone of the user.

ISO 8601 datetime

When the user was last updated.

User example object

{
  "id": 3924,
  "active": true,
  "bio": "Full stack developer at Gorgias",
  "created_datetime": "2019-04-13T03:27:56.973873",
  "country": "FR",
  "email": "[email protected]",
  "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"
}