Companies
The Companies model
Unique identifier for the company
Name of the company
Number of interactions
Owner ID
The Image URL of the company
A description of the 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
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 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
Name of the company
Owner ID
The Image URL of the company
A description of the company
The VAT number of the company
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The status of the company
The fax number of the company
The annual revenue of the company
Number of employees
The industry represents the type of business the company is in.
The ownership indicates the type of ownership of the company.
A sales tax number is a unique number that identifies a company for tax purposes.
A payee number is a unique number that identifies a payee for tax purposes.
An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.
An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.
The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.
The first name of the person.
The last name of the person.
Whether the company is read-only or not
A formal salutation for the person. For example, 'Mr', 'Mrs'
The date of birth of the person.
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
Name of the company
Owner ID
The Image URL of the company
A description of the company
The VAT number of the company
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The status of the company
The fax number of the company
The annual revenue of the company
Number of employees
The industry represents the type of business the company is in.
The ownership indicates the type of ownership of the company.
A sales tax number is a unique number that identifies a company for tax purposes.
A payee number is a unique number that identifies a payee for tax purposes.
An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.
An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.
The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.
The first name of the person.
The last name of the person.
Whether the company is read-only or not
A formal salutation for the person. For example, 'Mr', 'Mrs'
The date of birth of the person.
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
Mapping coverage per connector
Request example
Response example
Opportunities
The Opportunities model
A unique identifier for the opportunity.
The title or name of the opportunity.
The unique identifier of the primary contact associated with the opportunity.
A description of the opportunity.
The type of the opportunity
The monetary value associated with the opportunity
List opportunities
List opportunities
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 opportunity
Create opportunity
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 title or name of the opportunity.
The unique identifier of the primary contact associated with the opportunity.
A description of the opportunity.
The type of the opportunity
The monetary value associated with the opportunity
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The probability of winning the opportunity, expressed as a percentage.
The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.
The unique identifier of the reason why the opportunity was lost.
The reason why the opportunity was lost.
The unique identifier of the reason why the opportunity was won.
The reason why the opportunity was won.
The unique identifier of the pipeline associated with the opportunity
The unique identifier of the stage in the pipeline associated with the opportunity.
The unique identifier of the source of the opportunity.
The unique identifier of the lead associated with the opportunity.
The source of the lead associated with the opportunity.
The unique identifier of the contact associated with the opportunity.
An array of unique identifiers of all contacts associated with the opportunity.
The unique identifier of the company associated with the opportunity.
The name of the company associated with the opportunity.
The unique identifier of the user who owns the opportunity.
The priority level of the opportunity.
The current status of the opportunity.
The unique identifier of the current status of the opportunity.
The date and time when the stage of the opportunity was last changed.
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 opportunity
Get opportunity
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 opportunity
Update opportunity
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 title or name of the opportunity.
The unique identifier of the primary contact associated with the opportunity.
A description of the opportunity.
The type of the opportunity
The monetary value associated with the opportunity
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The probability of winning the opportunity, expressed as a percentage.
The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.
The unique identifier of the reason why the opportunity was lost.
The reason why the opportunity was lost.
The unique identifier of the reason why the opportunity was won.
The reason why the opportunity was won.
The unique identifier of the pipeline associated with the opportunity
The unique identifier of the stage in the pipeline associated with the opportunity.
The unique identifier of the source of the opportunity.
The unique identifier of the lead associated with the opportunity.
The source of the lead associated with the opportunity.
The unique identifier of the contact associated with the opportunity.
An array of unique identifiers of all contacts associated with the opportunity.
The unique identifier of the company associated with the opportunity.
The name of the company associated with the opportunity.
The unique identifier of the user who owns the opportunity.
The priority level of the opportunity.
The current status of the opportunity.
The unique identifier of the current status of the opportunity.
The date and time when the stage of the opportunity was last changed.
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 opportunity
Delete opportunity
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
Leads
The Leads model
Unique identifier for the contact.
Full name of the lead.
The name of the company the lead is associated with.
The owner of the lead.
The name of the owner of the lead.
The company the lead is associated with.
List leads
List leads
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 lead
Create lead
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
Full name of the lead.
The name of the company the lead is associated with.
The owner of the lead.
The name of the owner of the lead.
The company the lead is associated with.
The identifier of the lead.
The source of the lead.
The first name of the lead.
The last name of the lead.
The description of the lead.
The prefix of the lead.
The job title of the lead.
language code according to ISO 639-1. For the United States - EN
The monetary amount of the lead.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The fax number of the lead.
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 lead
Get lead
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 lead
Update lead
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
Full name of the lead.
The name of the company the lead is associated with.
The owner of the lead.
The name of the owner of the lead.
The company the lead is associated with.
The identifier of the lead.
The source of the lead.
The first name of the lead.
The last name of the lead.
The description of the lead.
The prefix of the lead.
The job title of the lead.
language code according to ISO 639-1. For the United States - EN
The monetary amount of the lead.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
The fax number of the lead.
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 lead
Delete lead
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
Contacts
The Contacts model
Unique identifier for the contact.
Full name of the contact.
The owner of the contact.
The type of the contact.
The company the contact is associated with.
The name of the company the contact is associated with.
List contacts
List contacts
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 contact
Create contact
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
Full name of the contact.
The owner of the contact.
The type of the contact.
The company the contact is associated with.
The name of the company the contact is associated with.
The lead the contact is associated with.
The first name of the contact.
The middle name of the contact.
The last name of the contact.
The prefix of the contact.
The suffix of the contact.
The job title of the contact.
The department of the contact.
language code according to ISO 639-1. For the United States - EN
The gender of the contact.
The birthday of the contact.
The URL of the photo of a person.
The lead source of the contact.
The fax number of the contact.
The description of the contact.
The current balance of the contact.
The status of the contact.
The active status of the contact.
The opportunity ids of the contact.
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 contact
Get contact
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
Responses
Mapping coverage per connector
Request example
Response example
Update contact
Update contact
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
Full name of the contact.
The owner of the contact.
The type of the contact.
The company the contact is associated with.
The name of the company the contact is associated with.
The lead the contact is associated with.
The first name of the contact.
The middle name of the contact.
The last name of the contact.
The prefix of the contact.
The suffix of the contact.
The job title of the contact.
The department of the contact.
language code according to ISO 639-1. For the United States - EN
The gender of the contact.
The birthday of the contact.
The URL of the photo of a person.
The lead source of the contact.
The fax number of the contact.
The description of the contact.
The current balance of the contact.
The status of the contact.
The active status of the contact.
The opportunity ids of the contact.
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 contact
Delete contact
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
Pipelines
The Pipelines model
The unique identifier of the Pipeline.
The name of the Pipeline.
Indicates the associated currency for an amount of money. Values correspond to ISO 4217.
Whether the Pipeline is archived or not.
Whether the Pipeline is active or not.
The order in which the Pipeline is displayed in the UI.
List pipelines
List pipelines
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 pipelineUpcoming
Create pipeline
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