Employees
The Employees model
List Employees
List Employees
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Apply filters (beta)
Responses
Mapping coverage per connector
Request example
Response example
Create Employee
Create Employee
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe division the user is currently in.
The department the user is currently in.
The team the user is currently in.
A Start Date is the date that the employee started working at the company
A Start Date is the date that the employee ended working at the company
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
country code according to ISO 3166-1 alpha-2.
language code according to ISO 639-1. For the United States - EN
Indicates whether the employee works remote
Indicate the employee's dietary preference.
Indicate the employee's food allergies.
Responses
Mapping coverage per connector
Request example
Response example
Get Employee
Get Employee
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Update Employee
Update Employee
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonThe division the user is currently in.
The department the user is currently in.
The team the user is currently in.
A Start Date is the date that the employee started working at the company
A Start Date is the date that the employee ended working at the company
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
country code according to ISO 3166-1 alpha-2.
language code according to ISO 639-1. For the United States - EN
Indicates whether the employee works remote
Indicate the employee's dietary preference.
Indicate the employee's food allergies.
Responses
Mapping coverage per connector
Request example
Response example
Delete Employee
Delete Employee
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Companies
The Companies model
An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
List Companies
List Companies
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Responses
Mapping coverage per connector
Request example
Response example
Create Company
Create Company
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonAn Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
Responses
Mapping coverage per connector
Request example
Response example
Get Company
Get Company
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Update Company
Update Company
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonAn Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
Responses
Mapping coverage per connector
Request example
Response example
Delete Company
Delete Company
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Departments
The Departments model
Department name
List Departments
List Departments
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
Number of records to return
Responses
Mapping coverage per connector
Request example
Response example
Create Department
Create Department
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonDepartment name
Responses
Request example
Response example
Get Department
Get Department
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Update Department
Update Department
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Request body schema
application/jsonDepartment name
Responses
Request example
Response example
Delete Department
Delete Department
Path parameters
ID of the record you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Payrolls
The Payrolls model
Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.
The date the payroll was processed.
The date on which employees will be paid for the payroll.
The start date, inclusive, of the pay period.
List Payroll
List Payroll
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Apply filters (beta)
Responses
Mapping coverage per connector
Request example
Response example
Get Payroll
Get Payroll
Path parameters
ID of the payroll you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Employee Payrolls
The Employee Payrolls model
List Employee Payrolls
List payrolls for employee
Path parameters
ID of the employee you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Apply filters (beta)
Responses
Mapping coverage per connector
Request example
Response example
Get Employee Payroll
Get payroll for employee
Path parameters
ID of the payroll you are acting upon.
ID of the employee you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Mapping coverage per connector
Request example
Response example
Employee Schedules
The Employee Schedules model
List Employee Schedules
List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee.
Path parameters
ID of the employee you are acting upon.
Header parameters
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.
Query parameters
Include raw response. Mostly used for debugging purposes
Responses
Request example
Response example
Employee updatedWebhook
Employee updated
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Request example
Employee deletedWebhook
Employee deleted
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Request example
Employee createdWebhook
Employee created
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Mapping coverage per connector
Request example
Company createdWebhook
Company created
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Company deletedWebhook
Company deleted
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example
Company updatedWebhook
Company updated
Request body schema
application/jsonUnique reference to this request event
Service provider identifier
The service provider's ID of the entity that triggered this event
The type entity that triggered this event
The url to retrieve entity detail.
The current count this request event has been attempted
ISO Datetime for when the original event occurred
Responses
Request example