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

int32

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.

deactivated_datetime

ISO 8601 datetime

When the user was deactivated.

email

email

Primary email address of the user.

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.

meta

object

Data associated with the user. You can use this field to store structured information (key-value data) about the user. Reserved keys: - avatar_url: The avatar URL of the user.

name

string

Full name of the user.

roles

array

The role of the user. A user can only have 1 role.

updated_datetime

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",
  "email": "steve@company.com",
  "external_id": "user-84203241",
  "firstname": "Steve",
  "lastname": "Frazeli",
  "meta": {
    "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
    "position": "engineer"
  },
  "name": "Steve Frazeli",
  "roles": {
    "id": 43728,
    "external_id": "role-hf329f",
    "name": "admin",
    "description": "Admins can manage all resources",
    "created_datetime": "2020-10-03T20:57:46.966927",
    "updated_datetime": "2020-11-27T04:21:23.472839"
  },
  "updated_datetime": "2019-09-25T06:18:22.839271"
}