Offers
The Offers model
A unique identifier for an object.
When custom mappings are configured on the resource, the result is included here.
The user who last updated the object.
The user who created the object.
The date and time when the object was last updated.
Activities
The Activities model
A unique identifier for an object.
When custom mappings are configured on the resource, the result is included here.
The user who last updated the object.
The user who created the object.
The date and time when the object was last updated.
The date and time when the object was created.
Jobs
The Jobs model
A unique identifier for an object.
The job title of the person.
Sequence in relation to other jobs.
The visibility of the job
The status of the job.
List Jobs
List Jobs
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
Get Job
Get Job
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
Applicants
The Applicants model
A unique identifier for an object.
The name of an applicant.
The first name of the person.
The last name of the person.
Middle name of the person.
The initials of the person, usually derived from their first, middle, and last names.
List Applicants
List Applicants
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 Applicant
Create Applicant
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
The name of an applicant.
The first name of the person.
The last name of the person.
Middle name of the person.
The initials of the person, usually derived from their first, middle, and last names.
The date of birth of the person.
The URL of the photo of a person.
Typically a list of previous companies where the contact has worked or schools that the contact has attended
The job title of the person.
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 Applicant
Get Applicant
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 Applicant
Update Applicant
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
The name of an applicant.
The first name of the person.
The last name of the person.
Middle name of the person.
The initials of the person, usually derived from their first, middle, and last names.
The date of birth of the person.
The URL of the photo of a person.
Typically a list of previous companies where the contact has worked or schools that the contact has attended
The job title of the person.
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 Applicant
Delete Applicant
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
Applications
The Applications model
A unique identifier for an object.
When custom mappings are configured on the resource, the result is included here.
List Applications
List Applications
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.
Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
Number of results to return. Minimum 1, Maximum 200, Default 20
Responses
Mapping coverage per connector
Request example
Response example
Create Application
Create Application
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
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 Application
Get Application
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 Application
Update Application
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
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 Application
Delete Application
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
Job CreatedWebhook
Event broadcast when a job 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
Job UpdatedWebhook
Event broadcast when a job 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
Job DeletedWebhook
Event broadcast when a job 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
Applicant CreatedWebhookUpcoming
Event broadcast when an applicant 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
Applicant UpdatedWebhookUpcoming
Event broadcast when an applicant 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
Applicant DeletedWebhookUpcoming
Event broadcast when an applicant 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
Application UpdatedWebhook
Event broadcast when an application has been updated.
Header parameters
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
Application DeletedWebhook
Event broadcast when an application has been deleted.
Header parameters
An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.
Request body schema
Responses
Example Event
Application CreatedWebhook
Event broadcast when an application has been created.
Header parameters
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