Appearance

List Employees ​

Endpoint ​

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

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
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.