Employees
The Employees model
A unique identifier for an object.
The first name of the person.
The last name of the person.
Middle name of the person.
The name used to display the employee, often a combination of their first and last names.
The name the employee prefers to be addressed by, which may be different from their legal name.
List Employees
Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call.
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 results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Apply sorting
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
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
A unique identifier for an object.
The first name of the person.
The last name of the person.
Middle name of the person.
The name used to display the employee, often a combination of their first and last names.
The name the employee prefers to be addressed by, which may be different from their legal name.
The initials of the person, usually derived from their first, middle, and last names.
A formal salutation for the person. For example, 'Mr', 'Mrs'
The job title of the person.
The marital status of the employee.
The division the person is currently in. Usually a collection of departments or teams or regions.
Unique identifier of the division this employee belongs to.
The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field.
Unique identifier of the department ID this employee belongs to.
Name of the department this employee belongs to.
The team the person is currently in.
The unique identifier of the company.
The name of the company.
A Start Date is the date that the employee started working at the company
An End Date is the date that the employee ended working at the company
The reason because the employment ended.
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
The ethnicity of the employee
Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.
A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
The date of birth of the person.
The date the person deceased.
Country code according to ISO 3166-1 alpha-2.
A description of the object.
The gender represents the gender identity of a person.
The preferred pronouns of the person.
language code according to ISO 639-1. For the United States - EN
The URL of the photo of a person.
The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.
Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).
Indicates if the employee works from a remote location.
Indicate the employee's dietary preference.
Indicate the employee's food allergies.
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
Flag to indicate if the object is deleted.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
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
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.
Example: fields=name,email,addresses.city
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.
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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
A unique identifier for an object.
The first name of the person.
The last name of the person.
Middle name of the person.
The name used to display the employee, often a combination of their first and last names.
The name the employee prefers to be addressed by, which may be different from their legal name.
The initials of the person, usually derived from their first, middle, and last names.
A formal salutation for the person. For example, 'Mr', 'Mrs'
The job title of the person.
The marital status of the employee.
The division the person is currently in. Usually a collection of departments or teams or regions.
Unique identifier of the division this employee belongs to.
The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field.
Unique identifier of the department ID this employee belongs to.
Name of the department this employee belongs to.
The team the person is currently in.
The unique identifier of the company.
The name of the company.
A Start Date is the date that the employee started working at the company
An End Date is the date that the employee ended working at the company
The reason because the employment ended.
An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
The ethnicity of the employee
Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.
A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
The date of birth of the person.
The date the person deceased.
Country code according to ISO 3166-1 alpha-2.
A description of the object.
The gender represents the gender identity of a person.
The preferred pronouns of the person.
language code according to ISO 639-1. For the United States - EN
The URL of the photo of a person.
The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.
Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).
Indicates if the employee works from a remote location.
Indicate the employee's dietary preference.
Indicate the employee's food allergies.
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
Flag to indicate if the object is deleted.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
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
A unique identifier for an object.
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 results to return. Minimum 1, Maximum 200, Default 20
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
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
An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
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
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.
Example: fields=name,email,addresses.city
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.
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
An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
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
A unique identifier for an object.
Parent ID
Department name
When custom mappings are configured on the resource, the result is included here.
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 results to return. Minimum 1, Maximum 200, Default 20
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
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
Department name
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
Responses
Mapping coverage per connector
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
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.
Example: fields=name,email,addresses.city
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.
Responses
Mapping coverage per connector
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
Department name
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
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
A unique identifier for an object.
The unique identifier of the company.
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
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
Responses
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
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.
Example: fields=name,email,addresses.city
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.
Responses
Request example
Response example
Employee Payrolls
The Employee Payrolls model
A unique identifier for an object.
ID of the employee
The unique identifier of the company.
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.
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
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
Responses
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
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.
Example: fields=name,email,addresses.city
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.
Responses
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
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
Responses
Mapping coverage per connector
Request example
Response example
Time Off Requests
The Time Off Requests model
A unique identifier for an object.
ID of the employee
ID of the policy
The status of the time off request.
Description of the time off request.
The start date of the time off request.
List Time Off Requests
List Time Off Requests
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 results to return. Minimum 1, Maximum 200, Default 20
Apply filters
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
Example: fields=name,email,addresses.city
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.
Responses
Mapping coverage per connector
Request example
Response example
Create Time Off Request
Create Time Off Request
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
ID of the employee
ID of the policy
The status of the time off request.
Description of the time off request.
The start date of the time off request.
The end date of the time off request.
The date the request was made.
The type of request
The date the request was approved
The unit of time off requested. Possible values include: hours, days, or other.
The amount of time off requested.
The day part of the time off request.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The policy type of the time off request
Responses
Mapping coverage per connector
Request example
Response example
Get Time Off Request
Get Time Off Request
Path parameters
ID of the record 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
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.
Example: fields=name,email,addresses.city
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.
Responses
Mapping coverage per connector
Request example
Response example
Update Time Off Request
Update Time Off Request
Path parameters
ID of the record 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
Request body schema
ID of the employee
ID of the policy
The status of the time off request.
Description of the time off request.
The start date of the time off request.
The end date of the time off request.
The date the request was made.
The type of request
The date the request was approved
The unit of time off requested. Possible values include: hours, days, or other.
The amount of time off requested.
The day part of the time off request.
The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
The policy type of the time off request
Responses
Mapping coverage per connector
Request example
Response example
Delete Time Off Request
Delete Time Off Request
Path parameters
ID of the record 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 CreatedWebhook
Event broadcast when an employee has been created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Employee UpdatedWebhook
Event broadcast when an employee has been updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Employee TerminatedWebhook
Event broadcast when an employee has been terminated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Employee DeletedWebhook
Event broadcast when an employee has been deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Mapping coverage per connector
Example Event
Company CreatedWebhook
Event broadcast when a company has been created.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Company UpdatedWebhook
Event broadcast when a company has been updated.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Company DeletedWebhook
Event broadcast when a company has been deleted.
Header parameters
The type of event that was triggered
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event