Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Employee

Retrieves a Employee resource.

Retrieves a Employee resource.

get/employees/{id}

Path parameters

idstring required

Resource identifier

Response

Employee resource

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring
firstNamestring nullable

First name of employee

lastNamestring nullable

Last name of employee

fullNamestring nullable
activeboolean
primaryPhonestring nullable
primaryAddrstring nullable
primaryAddrCitystring nullable
primaryAddrPostalcodestring nullable
primaryAddrStatestring nullable
createdstring date-time nullable
modifiedstring date-time nullable
linkstring nullable

Link to an external resource of the employee

emailstring nullable
mobilePhonestring nullable
payRatestring nullable
titlestring nullable
genderstring nullable
birthDatestring date-time nullable
hiredDatestring date-time nullable
employeeNumberstring nullable

Example response

{
  "id": "quickbooks-726",
  "integration": "quickbooks",
  "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
  "firstName": "Steve",
  "lastName": "James",
  "fullName": "Steve James",
  "active": true,
  "primaryPhone": "4168769854",
  "primaryAddr": "451 Lincoln street",
  "primaryAddrCity": "Toronto",
  "primaryAddrPostalcode": "L8H Y5F",
  "primaryAddrState": "California",
  "created": "2021-06-24 22:35:07",
  "modified": "2021-06-24 22:35:07",
  "link": "steve.james.com",
  "email": "steve.james@gmail.com",
  "mobilePhone": "4167854398",
  "payRate": "20",
  "title": "Mr",
  "gender": "Female",
  "birthDate": "2021-06-24",
  "hiredDate": "2021-06-24",
  "employeeNumber": "Female"
}