Appearance

List Users ​

Endpoint ​

http
GET /unified/crm/users
Integrations supported
  • Accelo
  • ActiveCampaign
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM

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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
email
string

The user's email

Supported in
  • Attio
  • Close
  • Monday CRM
  • Outreach
  • Pipedrive
  • Pipeliner
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
created_at
string · date-time

The date and time of the user's creation

Supported in
  • Outreach
  • Pipeliner
  • Salesforce
updated_at
string · date-time

The date and time of the user's last update

Supported in
  • Outreach
  • Pipeliner
  • Salesforce
sort_by

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

All possible enum values:
  • created_at
  • email
  • name
  • updated_at
Enum support by integration
  • Outreach
    • email
    • created_at
    • updated_at
  • Zendesk Sell
    • created_at
    • updated_at
    • name
  • Planhat
    • created_at
    • updated_at
    • email
  • Pipeliner
    • name
    • created_at
    • updated_at
    • email
  • Salesflare
    • name
    • created_at
    • updated_at
    • email
Supported in
  • Outreach
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
first_name
string
Supported in
  • Salesforce
last_name
string
Supported in
  • Salesforce
is_active
boolean

Whether the user is active

Supported in
  • Pipeliner
  • Zendesk Sell
  • Zoho CRM
name
string

The user's name

Supported in
  • Pipeliner
  • Salesflare
  • Zendesk Sell
search_term
Supported in
  • Salesflare
workspace
object
Required in
  • Highlevel
id
string
REQUIRED · 

Response Body ​

result
object[]

List of Users

id
string
REQUIRED · 

The user's unique identifier

Supported in
  • Accelo
  • ActiveCampaign
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
name
string

The user's name

Supported in
  • Accelo
  • ActiveCampaign
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
email
string

The user's email

Supported in
  • Accelo
  • ActiveCampaign
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
is_active
boolean

Whether the user is active

Supported in
  • Accelo
  • ActiveCampaign
  • Attio
  • Capsule
  • Microsoft Dynamics 365 Sales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
created_at
string · date-time

The date and time of the user's creation

Supported in
  • Accelo
  • Attio
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • Monday CRM
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Wix
  • Zendesk Sell
  • Zoho CRM
updated_at
string · date-time

The date and time of the user's last update

Supported in
  • Accelo
  • Capsule
  • Close
  • Microsoft Dynamics 365 Sales
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Wix
  • Zendesk Sell
  • Zoho CRM
urls
object[]

The user's urls

Supported in
  • Attio
  • Monday CRM
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
url
string

The user's URL

type
string

The user's URL type

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.