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

int32

ID of the user.

boolean

Whether the user can log in.

string

Short biography of the user.

array

This parameter has been deprecated and will be removed in a future version.

ISO 8601 datetime

When the user was created.

None

This parameter has been deprecated and will be removed in a future version.

None

This parameter has been deprecated and will be removed in a future version.

ISO 8601 datetime

When the user was deactivated.

email

Primary email address of the user.

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.

object

This parameter has been deprecated and will be removed in a future version.

string

Last name of the user.

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.

string

Full name of the user.

object

The role of the user.

array

This parameter has been deprecated and will be removed in a future version.

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": "[email protected]",
  "external_id": "user-84203241",
  "firstname": "Steve",
  "lastname": "Frazeli",
  "meta": {
    "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
    "position": "engineer"
  },
  "name": "Steve Frazelli",
  "role": {
    "id": 43728,
    "name": "admin"
  },
  "updated_datetime": "2019-09-25T06:18:22.839271"
}