Skip to content
GET /unified/ticketing/users

Partial response — use the "get" endpoint for the full object.

Query Parameters

Refer Specifying query parameters in Truto APIs

workspace
2 supported1 required
Asana
required
Help Scout
supported
usernamestring

The user's username

13 supported
BMC Helix
supported
eDesk
supported
Front
supported
FuseDesk
supported
Helpshift
supported
Microsoft 365
supported
Microsoft Planner
supported
Pivotal Tracker
supported
Qualtrics CoreXM
supported
ServiceNow
supported
Shortcut
supported
Teamwork Project Management
supported
YouTrack
supported
emailsobject[]

The user's email addresses

46 supported
Asana
supported
Azure DevOps
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Helpshift
supported
Hive
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
LiveAgent
supported
Microsoft 365
supported
Microsoft Planner
supported
Missive
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Puzzel Case Management
supported
Qualtrics CoreXM
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Todoist
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
emailstring
required·

The user's email address

typestring

The type of email address

team_id
2 supported
Dixa
supported
Freshchat
supported
team_idsstring[]

The IDs of the teams the user is a member of

12 supported
Asana
supported
ClickUp
supported
Dixa
supported
Freshchat
supported
Front
supported
FuseDesk
supported
Intercom
supported
Linear
supported
Shortcut
supported
SolarWinds Service Desk
supported
Trengo
supported
Zendesk
supported
sort_byobject
Possible values:
created_atemailsfirst_namelast_nameupdated_at
3 supported
Planhat
supported
first_namelast_namecreated_atupdated_atemails
Teamwork Project Management
supported
first_name
Gorgias
supported
created_atstring · date-time

The date and time the user was created

Possible values:
ascdesc
1 supported
Gorgias
supported
namestring

The name of the user to sort by.

Possible values:
ascdesc
1 supported
Gorgias
supported
search_term
2 supported
Jira
supported
Jira Service Management
supported
collectionsobject[]
2 supported2 required2 notes
Pivotal Tracker
required

Collection with type project is required.

Todoist
required

Collection of type project is required

idstring

The unique identifier for a collection

namestring

The user's name

46 supported
Asana
supported
Azure DevOps
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Helpshift
supported
Hive
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
LiveAgent
supported
Microsoft 365
supported
Microsoft Planner
supported
Missive
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Qualtrics CoreXM
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Todoist
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
updated_atstring · date-time

The date and time the user was last updated

20 supported
BMC Helix
supported
Dixa
supported
Freshdesk
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
Kustomer
supported
Linear
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
Teamwork Project Management
supported
Zendesk
supported
organizationobject
1 supported
Zoho Projects
supported
idstring

The unique identifier for a organization.

is_activeboolean

Whether the user is active or not

31 supported
Asana
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Linear
supported
LiveAgent
supported
Planhat
supported
Podium
supported
Puzzel Case Management
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

next_cursorstring

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.

resultobject[]

List of Users

idstring
required·

The user's unique identifier

47 supported
Asana
supported
Azure DevOps
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Helpshift
supported
Hive
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
LiveAgent
supported
Microsoft 365
supported
Microsoft Planner
supported
Missive
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Puzzel Case Management
supported
Qualtrics CoreXM
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Todoist
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
namestring
required·

The user's name

46 supported
Asana
supported
Azure DevOps
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Helpshift
supported
Hive
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
LiveAgent
supported
Microsoft 365
supported
Microsoft Planner
supported
Missive
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Qualtrics CoreXM
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Todoist
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
avatarstring

The URL of the user's avatar

19 supported
Asana
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
Freshchat
supported
FuseDesk
supported
Helpshift
supported
Jira
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
Missive
supported
Richpanel
supported
ServiceNow
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zendesk
supported
created_atstring · date-time

The date and time the user was created

24 supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
Freshchat
supported
Freshdesk
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
Kustomer
supported
Linear
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Zendesk
supported
emailsobject[]

The user's email addresses

46 supported
Asana
supported
Azure DevOps
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Enchant
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Help Scout
supported
Helpshift
supported
Hive
supported
Intercom
supported
Jira Service Management
supported
Kustomer
supported
Linear
supported
LiveAgent
supported
Microsoft 365
supported
Microsoft Planner
supported
Missive
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Puzzel Case Management
supported
Qualtrics CoreXM
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Todoist
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
2 properties
emailstring
required·

The user's email address

typestring

The type of email address

etagstring

The unique identifier for the specific version of the resource.

first_namestring

The user's first name

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

Whether the user is active or not

31 supported
Asana
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
eDesk
supported
Freshchat
supported
Freshdesk
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
HappyFox
supported
Intercom
supported
Jira
supported
Jira Service Management
supported
Linear
supported
LiveAgent
supported
Planhat
supported
Podium
supported
Puzzel Case Management
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
YouTrack
supported
Zendesk
supported
Zoho Desk
supported
Zoho Projects
supported
last_namestring

The user's last name

26 supported
Asana
supported
BMC Helix
supported
ClickUp
supported
Dixa
supported
Enchant
supported
Freshchat
supported
Front
supported
FuseDesk
supported
Gladly
supported
Gorgias
supported
Help Scout
supported
Hive
supported
Intercom
supported
Linear
supported
Microsoft 365
supported
Microsoft Planner
supported
Planhat
supported
Podium
supported
Qualtrics CoreXM
supported
Salesforce
supported
ServiceNow
supported
Superchat
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zoho Desk
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

rolesobject[]

The roles the user has

24 supported
Dixa
supported
eDesk
supported
Freshchat
supported
Front
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
Helpshift
supported
Kustomer
supported
LiveAgent
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Re:amaze
supported
Richpanel
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
SurveySparrow Ticket Management
supported
Teamwork Project Management
supported
Trengo
supported
Wrike
supported
Zoho Projects
supported
2 properties
idstring

The role's unique identifier

namestring

The role's name

team_idsstring[]

The IDs of the teams the user is a member of

12 supported
Asana
supported
ClickUp
supported
Dixa
supported
Freshchat
supported
Front
supported
FuseDesk
supported
Intercom
supported
Linear
supported
Shortcut
supported
SolarWinds Service Desk
supported
Trengo
supported
Zendesk
supported
updated_atstring · date-time

The date and time the user was last updated

20 supported
BMC Helix
supported
Dixa
supported
Freshdesk
supported
FuseDesk
supported
Gorgias
supported
Help Scout
supported
Kustomer
supported
Linear
supported
Pivotal Tracker
supported
Planhat
supported
Podium
supported
Re:amaze
supported
Richpanel
supported
Salesforce
supported
ServiceNow
supported
Shortcut
supported
SolarWinds Service Desk
supported
Superchat
supported
Teamwork Project Management
supported
Zendesk
supported
usernamestring

The user's username

13 supported
BMC Helix
supported
eDesk
supported
Front
supported
FuseDesk
supported
Helpshift
supported
Microsoft 365
supported
Microsoft Planner
supported
Pivotal Tracker
supported
Qualtrics CoreXM
supported
ServiceNow
supported
Shortcut
supported
Teamwork Project Management
supported
YouTrack
supported
curl -X GET 'https://api.truto.one/unified/ticketing/users?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/ticketing/users?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ticketing/users"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'ticketing',
  'users',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "ticketing",
        "users",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())