Appearance

List Users ​

Endpoint ​

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

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_key_by
string

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_limit
boolean

Ignores the limit query parameter.

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
emails
array

The user's email addresses

Supported in
  • Gorgias
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Gorgias
created_at
string · date-time

The date and time the user was created

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
name
string

The name of the user to sort by.

All possible enum values:
  • asc
  • desc
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
  • Shortcut
  • YouTrack
  • Zendesk
  • Zoho Desk
name
string
REQUIRED · 

The user's name

Supported in
  • Asana
  • ClickUp
  • Freshdesk
  • Gorgias
  • Happyfox
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Shortcut
  • YouTrack
  • 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
username
string

The user's username

Supported in
  • Shortcut
  • YouTrack
emails
object[]

The user's email addresses

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

The IDs of the teams the user is a member of

Supported in
  • Asana
  • ClickUp
  • Intercom
  • Linear
  • Shortcut
  • 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
  • Shortcut
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
  • Shortcut
  • Zendesk
updated_at
string · date-time

The date and time the user was last updated

Supported in
  • Freshdesk
  • Gorgias
  • Help Scout
  • Linear
  • Shortcut
  • 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.