Get Employee
Get Employee
Path parameters
ID of the record you are acting upon.
Query parameters
Include raw response. Mostly used for debugging purposes
The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
Headers
ID of the consumer which you want to get or push data from
The ID of your Unify application
Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Response
Employees
Example response
{
"status_code": 200,
"status": "OK",
"service": "quickbooks",
"resource": "Employees",
"operation": "one",
"data": {
"id": "12345",
"downstream_id": "12345",
"display_id": "123456",
"first_name": "John",
"last_name": "Doe",
"display_name": "John Doe",
"emails": [
{
"id": "123",
"email": "elon@musk.com",
"type": "primary"
}
],
"employee_number": "EMP-001",
"job_title": "Senior Accountant",
"status": "active",
"department": {
"id": "12345",
"display_id": "123456",
"name": "Acme Inc.",
"downstream_id": "12345"
},
"location": {
"id": "123456",
"display_id": "123456",
"name": "New York Office",
"downstream_id": "12345"
},
"manager": {
"id": "12345",
"name": "Jane Smith"
},
"hire_date": "2020-01-15",
"termination_date": "2025-12-31",
"gender": "male",
"birth_date": "1990-05-20",
"subsidiary": {
"id": "12345",
"display_id": "123456",
"name": "Acme Inc."
},
"tracking_categories": [
{
"id": "123456",
"code": "100",
"name": "New York",
"parent_id": "123456",
"parent_name": "New York"
}
],
"currency": "USD",
"notes": "Some notes about this employee",
"addresses": [
{
"id": "123",
"type": "primary",
"string": "25 Spring Street, Blackburn, VIC 3130",
"name": "HQ US",
"line1": "Main street",
"line2": "apt #",
"line3": "Suite #",
"line4": "delivery instructions",
"line5": "Attention: Finance Dept",
"street_number": "25",
"city": "San Francisco",
"state": "CA",
"postal_code": "94104",
"country": "US",
"latitude": "40.759211",
"longitude": "-73.984638",
"county": "Santa Clara",
"contact_name": "Elon Musk",
"salutation": "Mr",
"phone_number": "111-111-1111",
"fax": "122-111-1111",
"email": "elon@musk.com",
"website": "https://elonmusk.com",
"notes": "Address notes or delivery instructions.",
"row_version": "1-12345"
}
],
"phone_numbers": [
{
"id": "12345",
"country_code": "1",
"area_code": "323",
"number": "111-111-1111",
"extension": "105",
"type": "primary"
}
],
"bank_account": {
"bank_name": "Chase Bank",
"account_number": "123465",
"account_name": "Main Operating Account",
"account_type": "credit_card",
"iban": "GB33BUKB20201555555555",
"bic": "CHASUS33",
"routing_number": "021000021",
"bsb_number": "062-001",
"branch_identifier": "001",
"bank_code": "BNH",
"currency": "USD",
"country": "US"
},
"custom_fields": [
{
"id": "2389328923893298",
"name": "employee_level",
"description": "Employee Level",
"value": "Uses Salesforce and Marketo"
}
],
"row_version": "1-12345",
"updated_at": "2020-09-30T07:43:32.000Z",
"created_at": "2020-09-30T07:43:32.000Z",
"pass_through": [
{
"extend_paths": [
{
"path": "$.nested.property",
"value": {
"TaxClassificationRef": {
"value": "EUC-99990201-V1-00020000"
}
}
}
]
}
]
},
"meta": {
"items_on_page": 50,
"cursors": {
"previous": "em9oby1jcm06OnBhZ2U6OjE=",
"current": "em9oby1jcm06OnBhZ2U6OjI=",
"next": "em9oby1jcm06OnBhZ2U6OjM="
},
"total_count": 1,
"warnings": [
{
"type": "downstream_request_failed",
"status_code": 429,
"operation": "getManager"
}
]
}
}