List Employees ​
Endpoint ​
GET /unified/accounting/employees
Integrations supported
- QuickBooks
- Xero
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
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.
id
Ignores 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[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
The first name of the employee
Supported in
- Xero
The last name of the employee
Supported in
- Xero
This represents the date when the employee was updated
Supported in
- QuickBooks
- Xero
This represents the date when the employee was created
Supported in
- QuickBooks
- Xero
active
archived
Supported in
- QuickBooks
The display name of the employee
Supported in
- QuickBooks
Response Body ​
List of Employees
The unique identifier for employee
Supported in
- QuickBooks
- Xero
The first name of the employee
Supported in
- QuickBooks
- Xero
The last name of the employee
Supported in
- QuickBooks
- Xero
The display name of the employee
Supported in
- QuickBooks
The emails of the employee
Supported in
- QuickBooks
The email of the employee
The type of the email
The phone numbers of employee
Supported in
- QuickBooks
The phone number
The extension of the phone number
The type of phone
Supported in
- QuickBooks
The street 1 of the address
The street 2 of the address
The city of the address
The state of the address
The country of the address
The postal code of the address
The type of the address
This represents the date when the employee was created
Supported in
- QuickBooks
This represents the date when the employee was updated
Supported in
- QuickBooks
- Xero
Raw data returned from the remote API call.
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.