Appearance

List Users ​

Endpoint ​

http
GET /unified/e-signature/users
Integrations supported
  • Adobe Sign
  • DocuSign
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Adobe Sign

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
group
object

Group associated with the user.

Required in
  • DocuSign
id
string
type
string
All possible enum values:
  • signing_group
  • user_group

Response Body ​

result
object[]

List of Users

id
string
REQUIRED · 

The unique identifier for a user

Supported in
  • Adobe Sign
  • DocuSign
first_name
string

The first name of the user

Supported in
  • Adobe Sign
last_name
string

The last name of the user

Supported in
  • Adobe Sign
title
string

The title of the user

name
string

The name of the user

username
string

The username of the user

Supported in
  • Adobe Sign
  • DocuSign
emails
object[]

The emails of the user

Supported in
  • Adobe Sign
  • DocuSign
email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

phones
object[]

The phones of the user

number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

status
string

The status of the user. If no clear mapping is available, then the raw value is returned.

All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • DocuSign
roles
object[]

The roles of the user

id
string

The unique identifier for a role

name
string

The name of the role

group
string

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.

organization
string

The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.

workspace
string

The role of the user in the workspace. This is available when the user can have different roles in different workspaces in an application.

organizations
object[]

The organizations of the user

id
string

The unique identifier for an organization

name
string

The name of the organization

workspace
object

The workspace of the user

id
string

The unique identifier for a workspace

name
string

The name of the workspace

organization
string

The unique identifier of the organization to which the workspace belongs

groups
object[]

The groups of the user

Supported in
  • DocuSign
id
string

The unique identifier for a group

name
string

The name of the group

organization
string

The unique identifier of the organization to which the group belongs

avatar
string

The avatar of the user

timezone
string

The timezone of the user

languages
string[]

The languages preferred by the user

created_at
string · date-time

The date and time the user was created

updated_at
string · date-time

The date and time the user was last updated

urls
object[]

The URLs of the user

url
string

The URL

type
string

The type of URL

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.