Appearance

List Users ​

Endpoint ​

http
GET /unified/ticketing/users
Integrations supported
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Zendesk
  • Zoho Desk

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
emails
array
The user's email addresses
Supported in
  • Gorgias
workspace_id
string
The unique identifier for the workspace
Supported in
  • Asana

Response Body ​

result
object[]
List of Users
id
string
REQUIRED · The user's unique identifier
Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Zendesk
  • Zoho Desk
name
string
REQUIRED · The user's name
Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Zendesk
  • Zoho Desk
first_name
string
The user's first name
Supported in
  • Asana
  • ClickUp
  • Gorgias
  • Help Scout
  • Intercom
  • Linear
  • Zoho Desk
last_name
string
The user's last name
Supported in
  • Asana
  • ClickUp
  • Gorgias
  • Help Scout
  • Intercom
  • Linear
  • Zoho Desk
emails
object[]
The user's email addresses
Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Help Scout
  • Intercom
  • Linear
  • Zendesk
  • Zoho Desk
email
string
REQUIRED · The user's email address
type
string
The type of email address
is_active
boolean
Whether the user is active or not
Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Intercom
  • Jira
  • Linear
  • Zendesk
  • Zoho Desk
team_ids
string[]
The IDs of the teams the user is a member of
Supported in
  • Asana
  • ClickUp
  • Intercom
  • Linear
  • Zendesk
avatar
string
The URL of the user's avatar
Supported in
  • Asana
  • ClickUp
  • Jira
  • Linear
  • Zendesk
roles
object[]
The roles the user has
Supported in
  • Gorgias
  • Help Scout
id
string
The role's unique identifier
name
string
The role's name
created_at
string · date-time
The date and time the user was created
Supported in
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Linear
  • Zendesk
updated_at
string · date-time
The date and time the user was last updated
Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Linear
  • Zendesk
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.