Skip to content

Get Users

Endpoint

http
GET /unified/ticketing/users/{id}
Integrations supported
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Zendesk
  • Zoho Desk

Path parameters

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
team_id
string

The ClickUp Team (Workspace) ID

Required in
  • ClickUp

Response Body

id
string
REQUIRED · 

The user's unique identifier

Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Zendesk
  • Zoho Desk
name
string
REQUIRED · 

The user's name

Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • Jira
  • Zendesk
  • Zoho Desk
first_name
string

The user's first name

Supported in
  • Asana
  • ClickUp
  • Gorgias
  • Help Scout
  • Intercom
  • Zoho Desk
last_name
string

The user's last name

Supported in
  • Asana
  • ClickUp
  • Gorgias
  • Help Scout
  • Intercom
  • Zoho Desk
username
string

The user's username

emails
object[]

The user's email addresses

Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • 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
  • Intercom
  • Jira
  • Zendesk
  • Zoho Desk
team_ids
string[]

The IDs of the teams the user is a member of

Supported in
  • Asana
  • ClickUp
  • Intercom
  • Zendesk
avatar
string

The URL of the user's avatar

Supported in
  • Asana
  • ClickUp
  • HubSpot
  • Jira
  • Zendesk
roles
object[]

The roles the user has

Supported in
  • Gorgias
  • Help Scout
  • HubSpot
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
  • Zendesk
updated_at
string · date-time

The date and time the user was last updated

Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Zendesk
remote_data
object

Raw data returned from the remote API call.