Appearance

List Users ​

Endpoint ​

http
GET /unified/ats/users
Integrations supported
  • Ashby
  • Fountain
  • Greenhouse
  • Lever
  • Loxo
  • Recruiterflow
  • TalentLyft
  • Workable

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

The user's full name

Supported in
  • Workable
access_role
string

The user's access role

All possible enum values:
  • admin
  • no_access
  • reviewer
  • simple
Supported in
  • Workable
emails
array
Supported in
  • Workable

Response Body ​

result
object[]

List of Users

id
string
REQUIRED · 

The user's unique identifier

Supported in
  • Ashby
  • Fountain
  • Greenhouse
  • Lever
  • Loxo
  • Recruiterflow
  • TalentLyft
  • Workable
first_name
string

The user's first name

Supported in
  • Ashby
  • Greenhouse
  • Recruiterflow
last_name
string

The user's last name

Supported in
  • Ashby
  • Greenhouse
  • Recruiterflow
name
string

The user's full name

Supported in
  • Ashby
  • Fountain
  • Greenhouse
  • Lever
  • Loxo
  • Recruiterflow
  • TalentLyft
  • Workable
emails
object[]
Supported in
  • Ashby
  • Fountain
  • Greenhouse
  • Lever
  • Loxo
  • Recruiterflow
  • TalentLyft
  • Workable
email
string

Email of the user

type
string

Type of the email

is_primary
boolean

Whether the email is primary

disabled
boolean

The user's disabled status

Supported in
  • Ashby
  • Greenhouse
  • Lever
access_role
string

The user's access role

Supported in
  • Ashby
  • Greenhouse
  • Lever
  • Recruiterflow
  • TalentLyft
  • Workable
created_at
string · date-time

The date and time of the user's creation

Supported in
  • Greenhouse
  • Lever
  • Loxo
updated_at
string · date-time

The date and time of the user's last update

Supported in
  • Ashby
  • Greenhouse
  • Loxo
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.