Get Users

Endpoint

http

GET /unified/ticketing/users/{id}

Integrations supported

Asana
Azure DevOps
BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
HubSpot
Intercom
Jira
Jira Service Management
Kustomer
LiveAgent
Microsoft 365
Microsoft Planner
Pivotal Tracker
Planhat
Podium
Puzzel Case Management
Qualtrics CoreXM
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zendesk
Zoho Desk
Zoho Projects

Path parameters

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 returns the response with unified mappings applied.
raw returns the unprocessed, raw response from the remote API.
normalized applies the unified mappings and returns the data in a normalized format.
stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:

unified
raw
normalized
stream
debug

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

Required in

ClickUp

collections

array

Collection with type project is required.

Required in

Pivotal Tracker

organization

object

Supported in

Zoho Projects

string

The unique identifier for a organization.

Response Body

string

REQUIRED ·

The user's unique identifier

Supported in

Asana
Azure DevOps
BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
HubSpot
Intercom
Jira
Jira Service Management
Kustomer
LiveAgent
Microsoft 365
Microsoft Planner
Pivotal Tracker
Planhat
Podium
Puzzel Case Management
Qualtrics CoreXM
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zendesk
Zoho Desk
Zoho Projects

name

string

REQUIRED ·

The user's name

Supported in

Asana
Azure DevOps
BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
HubSpot
Intercom
Jira
Jira Service Management
Kustomer
LiveAgent
Microsoft 365
Microsoft Planner
Pivotal Tracker
Planhat
Podium
Qualtrics CoreXM
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zendesk
Zoho Desk
Zoho Projects

first_name

string

The user's first name

Supported in

Asana
BMC Helix
ClickUp
Dixa
Freshchat
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
Intercom
Microsoft 365
Microsoft Planner
Planhat
Podium
Qualtrics CoreXM
Salesforce
ServiceNow
Superchat
Teamwork Project Management
Trengo
Wrike
Zoho Desk

last_name

string

The user's last name

Supported in

Asana
BMC Helix
ClickUp
Dixa
Freshchat
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
Intercom
Microsoft 365
Microsoft Planner
Planhat
Podium
Qualtrics CoreXM
Salesforce
ServiceNow
Superchat
Teamwork Project Management
Trengo
Wrike
Zoho Desk

username

string

The user's username

Supported in

BMC Helix
Front
FuseDesk
Microsoft 365
Microsoft Planner
Pivotal Tracker
Qualtrics CoreXM
ServiceNow
Teamwork Project Management

emails

object[]

The user's email addresses

Supported in

Asana
Azure DevOps
BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Help Scout
Hive
HubSpot
Intercom
Jira Service Management
Kustomer
LiveAgent
Microsoft 365
Microsoft Planner
Pivotal Tracker
Planhat
Podium
Puzzel Case Management
Qualtrics CoreXM
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zendesk
Zoho Desk
Zoho Projects

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
BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
Front
FuseDesk
Gladly
Gorgias
Intercom
Jira
Jira Service Management
LiveAgent
Planhat
Podium
Puzzel Case Management
Salesforce
ServiceNow
SolarWinds Service Desk
Teamwork Project Management
Trengo
Wrike
Zendesk
Zoho Desk
Zoho Projects

team_ids

string[]

The IDs of the teams the user is a member of

Supported in

Asana
ClickUp
Dixa
Freshchat
Front
FuseDesk
Intercom
SolarWinds Service Desk
Trengo
Zendesk

avatar

string

The URL of the user's avatar

Supported in

Asana
BMC Helix
ClickUp
Dixa
Freshchat
FuseDesk
HubSpot
Jira
Jira Service Management
Kustomer
Richpanel
ServiceNow
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zendesk

roles

object[]

The roles the user has

Supported in

Dixa
Freshchat
Front
FuseDesk
Gorgias
Help Scout
HubSpot
Kustomer
LiveAgent
Pivotal Tracker
Planhat
Podium
Richpanel
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Wrike
Zoho Projects

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

BMC Helix
ClickUp
Dixa
Freshchat
Freshdesk
FuseDesk
Gorgias
Help Scout
Kustomer
Pivotal Tracker
Planhat
Podium
Qualtrics CoreXM
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
SurveySparrow Ticket Management
Teamwork Project Management
Trengo
Zendesk

updated_at

string · date-time

The date and time the user was last updated

Supported in

BMC Helix
Dixa
Freshdesk
FuseDesk
Gorgias
Help Scout
Kustomer
Pivotal Tracker
Planhat
Podium
Richpanel
Salesforce
ServiceNow
SolarWinds Service Desk
Superchat
Teamwork Project Management
Zendesk

etag

string

The unique identifier for the specific version of the resource.

remote_data

object

Raw data returned from the remote API call.