Appearance

Get Employees ​

Endpoint ​

http
GET /unified/accounting/employees/{id}
Integrations supported
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
  • Zoho Books

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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 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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
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

Response Body ​

id
string
REQUIRED · 

The unique identifier for employee

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
  • Zoho Books
first_name
string

The first name of the employee

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
last_name
string

The last name of the employee

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
name
string

The display name of the employee

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Zoho Books
emails
object[]

The emails of the employee

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Zoho Books
email
string

The email of the employee

type
string

The type of the email

phones
object[]

The phone numbers of employee

Supported in
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Zoho Books
number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone

addresses
object[]
Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • 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
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Zoho Books
updated_at
string · date-time

This represents the date when the employee was updated

Supported in
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Xero
remote_data
object

Raw data returned from the remote API call.