Skip to content
GET /unified/crm/users

Query Parameters

Refer Specifying query parameters in Truto APIs

emailstring

The user's email

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the user's last update

17 supported
Accelo
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
workspaceobject
1 supported1 required
Highlevel
required
idstring
required
created_atstring · date-time

The date and time of the user's creation

19 supported
Accelo
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
sort_by
Possible values:
created_atemailnameupdated_at
5 supported
Outreach
supported
emailcreated_atupdated_at
Pipeliner
supported
namecreated_atupdated_atemail
Planhat
supported
created_atupdated_atemail
Salesflare
supported
namecreated_atupdated_atemail
Zendesk Sell
supported
created_atupdated_atname
namestring

The user's name

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
is_activeboolean

Whether the user is active

20 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
search_term
1 supported
Salesflare
supported
first_namestring
1 supported
Salesforce
supported
last_namestring
1 supported
Salesforce
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

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the user's creation

19 supported
Accelo
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
emailstring

The user's email

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
is_activeboolean

Whether the user is active

20 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
namestring

The user's name

24 supported
Accelo
supported
ActiveCampaign
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Teamleader
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

updated_atstring · date-time

The date and time of the user's last update

17 supported
Accelo
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Salesforce
supported
Wix
supported
Zendesk Sell
supported
Zoho CRM
supported
urlsobject[]

The user's urls

7 supported
Attio
supported
Monday CRM
supported
OnePageCRM
supported
Pipedrive
supported
Salesforce
supported
Zendesk Sell
supported
Zoho CRM
supported
2 properties
typestring

The user's URL type

urlstring

The user's URL

curl -X GET 'https://api.truto.one/unified/crm/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/crm/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/crm/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(
  'crm',
  '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(
        "crm",
        "users",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())