List Users
/unified/e-signature/users
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
Group associated with the user.
1 supported1 required
signing_groupuser_group
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.
unifiedunifiedrawnormalizedstream
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.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
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.
List of Users
The unique identifier for a user
4 supported
The avatar of the user
1 supported
The date and time the user was created
1 supported
The emails of the user
4 supported
3 properties
The email address
Whether the email address is primary
The type of email address
The first name of the user
2 supported
The groups of the user
2 supported
3 properties
The unique identifier for a group
The name of the group
The unique identifier of the organization to which the group belongs
The languages preferred by the user
1 supported
The last name of the user
2 supported
The name of the user
2 supported
The organizations of the user
2 properties
The unique identifier for an organization
The name of the organization
The phones of the user
1 supported
3 properties
The extension of the phone number
The phone number
The type of phone number
Raw data returned from the remote API call.
The roles of the user
2 supported
5 properties
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
The unique identifier for a role
The name of the role
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.
The status of the user. If no clear mapping is available, then the raw value is returned.
activeinactivedeletedinvited
3 supported
The timezone of the user
1 supported
The title of the user
2 supported
The date and time the user was last updated
1 supported
The URLs of the user
1 supported
2 properties
The type of URL
The URL
The username of the user
3 supported
The workspace of the user
3 properties
The unique identifier for a workspace
The name of the workspace
The unique identifier of the organization to which the workspace belongs
curl -X GET 'https://api.truto.one/unified/e-signature/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/e-signature/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/e-signature/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(
'e-signature',
'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(
"e-signature",
"users",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())