Skip to content

List Employees

Endpoint

http
GET /unified/accounting/employees
Integrations supported
  • QuickBooks
  • Xero

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

The first name of the employee

Supported in
  • Xero
last_name
string

The last name of the employee

Supported in
  • Xero
updated_at
string · date-time

This represents the date when the employee was updated

Supported in
  • QuickBooks
  • Xero
created_at
string · date-time

This represents the date when the employee was created

Supported in
  • QuickBooks
  • Xero
status
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
name
string

The display name of the employee

Supported in
  • QuickBooks

Response Body

result
object[]

List of Employees

id
string
REQUIRED · 

The unique identifier for employee

Supported in
  • QuickBooks
  • Xero
first_name
string

The first name of the employee

Supported in
  • QuickBooks
  • Xero
last_name
string

The last name of the employee

Supported in
  • QuickBooks
  • Xero
name
string

The display name of the employee

Supported in
  • QuickBooks
emails
object[]

The emails of the employee

Supported in
  • QuickBooks
email
string

The email of the employee

type
string

The type of the email

phones
object[]

The phone numbers of employee

Supported in
  • QuickBooks
number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone

addresses
object[]
Supported in
  • QuickBooks
street_1
string

The street 1 of the address

street_2
string

The street 2 of the address

city
string

The city of the address

state
string

The state of the address

country
string

The country of the address

postal_code
string

The postal code of the address

type
string

The type of the address

created_at
string · date-time

This represents the date when the employee was created

Supported in
  • QuickBooks
updated_at
string · date-time

This represents the date when the employee was updated

Supported in
  • QuickBooks
  • Xero
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.