CRM API Reference

One single API to push and pull data from multiple connectors.

10.9.0

Introduction

Welcome to the CRM API.

You can use this API to access all CRM API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

Name	Type	Required	Description
x-apideck-consumer-id	String	Yes	The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-id	String	No	Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-raw	Boolean	No	Include raw response. Mostly used for debugging purposes.
x-apideck-app-id	String	Yes	The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
Authorization	String	Yes	Bearer API KEY

Authorization

You can interact with the API through the authorization methods below.

apiKey

To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page.

Authenticate your API requests by including your test or live secret API key in the request header.

Bearer authorization header: Authorization: Bearer "YOUR_API_KEY_HERE"
Application id header: x-apideck-app-id: "YOUR_APP_ID_HERE"

You should use the public keys on the SDKs and the secret keys to authenticate API requests.

Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.

Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key

Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

Security Scheme Type	API Key
Header parameter name	Authorization

applicationId

The ID of your Unify application

Security Scheme Type	API Key
Header parameter name	x-apideck-app-id

consumerId

The ID of the consumer which you want to get or push data from

Security Scheme Type	API Key
Header parameter name	x-apideck-consumer-id

Pagination

All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

Name	Type	Required	Description
cursor	String	No	Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limit	Number	No	Number of results to return. Minimum 1, Maximum 200, Default 20

Response Body

Name	Type	Description
meta.cursors.previous	String	Cursor to navigate to the previous page of results through the API
meta.cursors.current	String	Cursor to navigate to the current page of results through the API
meta.cursors.next	String	Cursor to navigate to the next page of results through the API
meta.items_on_page	Number	Number of items returned in the data property of the response
links.previous	String	Link to navigate to the previous page of results through the API
links.current	String	Link to navigate to the current page of results through the API
links.next	String	Link to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

We currently offer a Node.js, PHP, Python and .NET SDK. Need another SDK? Request the SDK of your choice.

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

Code	Title	Description
200	OK	The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.
201	Created	The request has been fulfilled and has resulted in one or more new resources being created.
204	No Content	The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400	Bad Request	The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request.
401	Unauthorized	The request has not been applied because it lacks valid authentication credentials for the target resource.
402	Payment Required	Subscription data is incomplete or out of date. You'll need to provide payment details to continue.
403	Forbidden	You do not have the appropriate user rights to access the request. Do not repeat the request.
404	Not Found	The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
409	Conflict	The request could not be completed due to a conflict with the current state of the target resource.
422	Unprocessable Entity	The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
429	Too Many Requests	You sent too many requests in a given amount of time ("rate limit"). Try again later
5xx	Server Errors	Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.

Handling errors

The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.

Error Types

RequestValidationError

Request is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.

UnsupportedFiltersError

Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.

UnsupportedSortFieldError

Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.

InvalidCursorError

Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.

ConnectorExecutionError

A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail.

UnauthorizedError

We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sk_live_***'

ConnectorCredentialsError

A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.

ConnectorDisabledError

A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.

ConnectorRateLimitError

You sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.

RequestLimitError

You have reached the number of requests included in your Free Tier Subscription. You will not be able to make further requests until you upgrade your subscription. Please reach out to sales@apideck.com to continue making requests.

EntityNotFoundError

You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.

OAuthCredentialsNotFoundError

When adding a connector integration that implements OAuth, both a client_id and client_secret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.

IntegrationNotFoundError

The requested connector integration could not be found associated to your application_id. Verify your application_id is correct, and that this connector has been added and configured for your application.

ConnectionNotFoundError

A valid connection could not be found associated to your application_id. Something may have interrupted the authorization flow. You may need to start the connector authorization process again.

ConnectionSettingsError

The connector has required settings that were not supplied. Verify connection.settings contains all required settings for the connector to be callable.

ConnectorNotFoundError

A request was made for an unknown connector. Verify your service_id is spelled correctly, and that this connector is enabled for your provided unified_api.

OAuthRedirectUriError

A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process.

OAuthInvalidStateError

The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.

OAuthCodeExchangeError

When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.

OAuthConnectorError

It seems something went wrong on the connector side. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

MappingError

There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.

ConnectorMappingNotFoundError

It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorResponseMappingNotFoundError

We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationMappingNotFoundError

Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorWorkflowMappingError

The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationUnsupportedError

You're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.

PaginationNotSupportedError

Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

API Design

API Styles and data formats

REST API

The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.

Available HTTP methods

The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

POST /messages
GET /messages
GET /messages/{messageId}
PATCH /messages/{messageId}
DELETE /messages/{messageId}

Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.

Schema

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Fixed field types

Dates

The dates returned by the API are all represented in UTC (ISO8601 format).

This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition.

The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.

Prices and Currencies

All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).

For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.

All currency codes conform to ISO 4217.

Support

If you have problems or need help with your case, you can always reach out to our Support.

Static IP

Some of the APIs you want to use can require a static IP. Apideck's static IP feature allows you to use Apideck with a fixed IP avoiding the need for you to set up your own infrastructure. This feature is currently available to all Apideck customers. To use this feature, the API Vendor will need to whitelist the associated static IP addresses. The provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.

EU Central 1: 18.197.244.247, 18.156.9.3, 3.65.139.215
Other: upcoming

More info about our data security can be found at https://compliance.apideck.com/

Companies

The Companies model

idstring

Unique identifier for the company

namestring or null

required

Name of the company

interaction_countinteger or null

Number of interactions

owner_idstring or null

Owner ID

imagestring or null

The Image URL of the company

descriptionstring or null

A description of the company

Companies example

{}

List companies

get

https://unify.apideck.com/crm/companies

List companies

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[name]=SpaceX

Apply filters

sortobjectsort[by]=created_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

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

200Companies

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.companiesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "SpaceX",
      "interaction_count": 1,
      "owner_id": "12345",
      "image": "https://www.spacex.com/static/images/share.jpg",
      "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
      "vat_number": "BE0689615164",
      "currency": "USD",
      "status": "Open",
      "fax": "+12129876543",
      "annual_revenue": "+$35m",
      "number_of_employees": "500-1000",
      "industry": "Apparel",
      "ownership": "Public",
      "sales_tax_number": "12456EN",
      "payee_number": "78932EN",
      "abn_or_tfn": "46 115 614 695",
      "abn_branch": "123",
      "acn": "XXX XXX XXX",
      "first_name": "Elon",
      "last_name": "Musk",
      "parent_id": "22345",
      "bank_accounts": [
        {
          "bank_name": "Monzo",
          "account_number": "123465",
          "account_name": "SPACEX LLC",
          "account_type": "credit_card",
          "iban": "CH2989144532982975332",
          "bic": "AUDSCHGGXXX",
          "routing_number": "012345678",
          "bsb_number": "062-001",
          "branch_identifier": "001",
          "bank_code": "BNH",
          "currency": "USD"
        }
      ],
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "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",
          "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"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "row_type": {
        "id": "12345",
        "name": "Customer Account"
      },
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "read_only": false,
      "last_activity_at": "2020-09-30T07:43:32.000Z",
      "deleted": false,
      "salutation": "Mr",
      "birthday": "2000-08-12",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create company

post

https://unify.apideck.com/crm/companies

Create company

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring or null

required

Name of the company

owner_idstring or null

Owner ID

imagestring or null

The Image URL of the company

descriptionstring or null

A description of the company

vat_numberstring or null

The VAT number of the company

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

statusstring or null

The status of the company

faxstring or null

The fax number of the company

annual_revenuestring or null

The annual revenue of the company

number_of_employeesstring or null

Number of employees

industrystring or null

The industry represents the type of business the company is in.

ownershipstring or null

The ownership indicates the type of ownership of the company.

sales_tax_numberstring or null

A sales tax number is a unique number that identifies a company for tax purposes.

payee_numberstring or null

A payee number is a unique number that identifies a payee for tax purposes.

abn_or_tfnstring or null

An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.

abn_branchstring or null

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.

acnstring or null

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.

first_namestring or null

The first name of the person.

last_namestring or null

The last name of the person.

bank_accountsobjects

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

row_typeobject

custom_fieldsobjects

tagsstrings or null

read_onlyboolean or null

Whether the company is read-only or not

salutationstring or null

A formal salutation for the person. For example, 'Mr', 'Mrs'

birthdaystring or null

The date of birth of the person.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Company created

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "name": "SpaceX",
  "owner_id": "12345",
  "image": "https://www.spacex.com/static/images/share.jpg",
  "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
  "vat_number": "BE0689615164",
  "currency": "USD",
  "status": "Open",
  "fax": "+12129876543",
  "annual_revenue": "+$35m",
  "number_of_employees": "500-1000",
  "industry": "Apparel",
  "ownership": "Public",
  "sales_tax_number": "12456EN",
  "payee_number": "78932EN",
  "abn_or_tfn": "46 115 614 695",
  "abn_branch": "123",
  "acn": "XXX XXX XXX",
  "first_name": "Elon",
  "last_name": "Musk",
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "row_type": {
    "id": "12345",
    "name": "Customer Account"
  },
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "read_only": false,
  "salutation": "Mr",
  "birthday": "2000-08-12",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get company

get

https://unify.apideck.com/crm/companies/{id}

Get company

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

Responses

200Company

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.companiesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "SpaceX",
    "interaction_count": 1,
    "owner_id": "12345",
    "image": "https://www.spacex.com/static/images/share.jpg",
    "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
    "vat_number": "BE0689615164",
    "currency": "USD",
    "status": "Open",
    "fax": "+12129876543",
    "annual_revenue": "+$35m",
    "number_of_employees": "500-1000",
    "industry": "Apparel",
    "ownership": "Public",
    "sales_tax_number": "12456EN",
    "payee_number": "78932EN",
    "abn_or_tfn": "46 115 614 695",
    "abn_branch": "123",
    "acn": "XXX XXX XXX",
    "first_name": "Elon",
    "last_name": "Musk",
    "parent_id": "22345",
    "bank_accounts": [
      {
        "bank_name": "Monzo",
        "account_number": "123465",
        "account_name": "SPACEX LLC",
        "account_type": "credit_card",
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX",
        "routing_number": "012345678",
        "bsb_number": "062-001",
        "branch_identifier": "001",
        "bank_code": "BNH",
        "currency": "USD"
      }
    ],
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "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",
        "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"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "row_type": {
      "id": "12345",
      "name": "Customer Account"
    },
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "read_only": false,
    "last_activity_at": "2020-09-30T07:43:32.000Z",
    "deleted": false,
    "salutation": "Mr",
    "birthday": "2000-08-12",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update company

patch

https://unify.apideck.com/crm/companies/{id}

Update company

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring or null

required

Name of the company

owner_idstring or null

Owner ID

imagestring or null

The Image URL of the company

descriptionstring or null

A description of the company

vat_numberstring or null

The VAT number of the company

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

statusstring or null

The status of the company

faxstring or null

The fax number of the company

annual_revenuestring or null

The annual revenue of the company

number_of_employeesstring or null

Number of employees

industrystring or null

The industry represents the type of business the company is in.

ownershipstring or null

The ownership indicates the type of ownership of the company.

sales_tax_numberstring or null

A sales tax number is a unique number that identifies a company for tax purposes.

payee_numberstring or null

A payee number is a unique number that identifies a payee for tax purposes.

abn_or_tfnstring or null

An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.

abn_branchstring or null

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.

acnstring or null

first_namestring or null

The first name of the person.

last_namestring or null

The last name of the person.

bank_accountsobjects

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

row_typeobject

custom_fieldsobjects

tagsstrings or null

read_onlyboolean or null

Whether the company is read-only or not

salutationstring or null

A formal salutation for the person. For example, 'Mr', 'Mrs'

birthdaystring or null

The date of birth of the person.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Company updated

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "name": "SpaceX",
  "owner_id": "12345",
  "image": "https://www.spacex.com/static/images/share.jpg",
  "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
  "vat_number": "BE0689615164",
  "currency": "USD",
  "status": "Open",
  "fax": "+12129876543",
  "annual_revenue": "+$35m",
  "number_of_employees": "500-1000",
  "industry": "Apparel",
  "ownership": "Public",
  "sales_tax_number": "12456EN",
  "payee_number": "78932EN",
  "abn_or_tfn": "46 115 614 695",
  "abn_branch": "123",
  "acn": "XXX XXX XXX",
  "first_name": "Elon",
  "last_name": "Musk",
  "bank_accounts": [
    {
      "bank_name": "Monzo",
      "account_number": "123465",
      "account_name": "SPACEX LLC",
      "account_type": "credit_card",
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX",
      "routing_number": "012345678",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "row_type": {
    "id": "12345",
    "name": "Customer Account"
  },
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "read_only": false,
  "salutation": "Mr",
  "birthday": "2000-08-12",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete company

delete

https://unify.apideck.com/crm/companies/{id}

Delete company

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Company deleted

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.companiesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Opportunities

The Opportunities model

idstring

A unique identifier for the opportunity.

titlestringnon-empty

required

The title or name of the opportunity.

primary_contact_idstring or null

required

The unique identifier of the primary contact associated with the opportunity.

descriptionstring or null

A description of the opportunity.

typestring or null

The type of the opportunity

monetary_amountnumber or null

The monetary value associated with the opportunity

Opportunities example

{}

List opportunities

get

https://unify.apideck.com/crm/opportunities

List opportunities

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[title]=Tesla deal

Apply filters

sortobjectsort[by]=created_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

Responses

200Opportunities

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.opportunitiesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "title": "New Rocket",
      "primary_contact_id": "12345",
      "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
      "type": "Existing Customer - Upgrade",
      "monetary_amount": 75000,
      "currency": "USD",
      "win_probability": 40,
      "expected_revenue": 75000,
      "close_date": "2020-10-30",
      "loss_reason_id": "12345",
      "loss_reason": "No budget",
      "won_reason_id": "12345",
      "won_reason": "Best pitch",
      "pipeline_id": "12345",
      "pipeline_stage_id": "12345",
      "source_id": "12345",
      "lead_id": "12345",
      "lead_source": "Website",
      "contact_id": "12345",
      "contact_ids": [
        "12345"
      ],
      "company_id": "12345",
      "company_name": "Copper",
      "owner_id": "12345",
      "priority": "None",
      "status": "Open",
      "status_id": "12345",
      "tags": [
        "New"
      ],
      "interaction_count": 0,
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "stage_last_changed_at": "2020-09-30T07:43:32.000Z",
      "last_activity_at": "2020-09-30T07:43:32.000Z",
      "deleted": false,
      "date_stage_changed": "2020-09-30T00:00:00.000Z",
      "date_last_contacted": "2020-09-30T00:00:00.000Z",
      "date_lead_created": "2020-09-30T00:00:00.000Z",
      "custom_mappings": {},
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create opportunity

post

https://unify.apideck.com/crm/opportunities

Create opportunity

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

titlestringnon-empty

required

The title or name of the opportunity.

primary_contact_idstring or null

required

The unique identifier of the primary contact associated with the opportunity.

descriptionstring or null

A description of the opportunity.

typestring or null

The type of the opportunity

monetary_amountnumber or null

The monetary value associated with the opportunity

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

win_probabilitynumber or null

The probability of winning the opportunity, expressed as a percentage.

close_datestring or null

The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.

loss_reason_idstring or null

The unique identifier of the reason why the opportunity was lost.

loss_reasonstring or null

The reason why the opportunity was lost.

won_reason_idstring or null

The unique identifier of the reason why the opportunity was won.

won_reasonstring or null

The reason why the opportunity was won.

pipeline_idstring or null

The unique identifier of the pipeline associated with the opportunity

pipeline_stage_idstring or null

The unique identifier of the stage in the pipeline associated with the opportunity.

source_idstring or null

The unique identifier of the source of the opportunity.

lead_idstring or null

The unique identifier of the lead associated with the opportunity.

lead_sourcestring or null

The source of the lead associated with the opportunity.

contact_idstring or null

The unique identifier of the contact associated with the opportunity.

contact_idsstrings

An array of unique identifiers of all contacts associated with the opportunity.

company_idstring or null

The unique identifier of the company associated with the opportunity.

company_namestring or null

The name of the company associated with the opportunity.

owner_idstring or null

The unique identifier of the user who owns the opportunity.

prioritystring or null

The priority level of the opportunity.

statusstring or null

The current status of the opportunity.

status_idstring or null

The unique identifier of the current status of the opportunity.

tagsstrings or null

custom_fieldsobjects

stage_last_changed_atstring or null

The date and time when the stage of the opportunity was last changed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Opportunity created

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "title": "New Rocket",
  "primary_contact_id": "12345",
  "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "type": "Existing Customer - Upgrade",
  "monetary_amount": 75000,
  "currency": "USD",
  "win_probability": 40,
  "close_date": "2020-10-30",
  "loss_reason_id": "12345",
  "loss_reason": "No budget",
  "won_reason_id": "12345",
  "won_reason": "Best pitch",
  "pipeline_id": "12345",
  "pipeline_stage_id": "12345",
  "source_id": "12345",
  "lead_id": "12345",
  "lead_source": "Website",
  "contact_id": "12345",
  "contact_ids": [
    "12345"
  ],
  "company_id": "12345",
  "company_name": "Copper",
  "owner_id": "12345",
  "priority": "None",
  "status": "Open",
  "status_id": "12345",
  "tags": [
    "New"
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "stage_last_changed_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get opportunity

get

https://unify.apideck.com/crm/opportunities/{id}

Get opportunity

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

Responses

200Opportunity

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.opportunitiesOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "one",
  "data": {
    "id": "12345",
    "title": "New Rocket",
    "primary_contact_id": "12345",
    "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
    "type": "Existing Customer - Upgrade",
    "monetary_amount": 75000,
    "currency": "USD",
    "win_probability": 40,
    "expected_revenue": 75000,
    "close_date": "2020-10-30",
    "loss_reason_id": "12345",
    "loss_reason": "No budget",
    "won_reason_id": "12345",
    "won_reason": "Best pitch",
    "pipeline_id": "12345",
    "pipeline_stage_id": "12345",
    "source_id": "12345",
    "lead_id": "12345",
    "lead_source": "Website",
    "contact_id": "12345",
    "contact_ids": [
      "12345"
    ],
    "company_id": "12345",
    "company_name": "Copper",
    "owner_id": "12345",
    "priority": "None",
    "status": "Open",
    "status_id": "12345",
    "tags": [
      "New"
    ],
    "interaction_count": 0,
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "stage_last_changed_at": "2020-09-30T07:43:32.000Z",
    "last_activity_at": "2020-09-30T07:43:32.000Z",
    "deleted": false,
    "date_stage_changed": "2020-09-30T00:00:00.000Z",
    "date_last_contacted": "2020-09-30T00:00:00.000Z",
    "date_lead_created": "2020-09-30T00:00:00.000Z",
    "custom_mappings": {},
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update opportunity

patch

https://unify.apideck.com/crm/opportunities/{id}

Update opportunity

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

titlestringnon-empty

required

The title or name of the opportunity.

primary_contact_idstring or null

required

The unique identifier of the primary contact associated with the opportunity.

descriptionstring or null

A description of the opportunity.

typestring or null

The type of the opportunity

monetary_amountnumber or null

The monetary value associated with the opportunity

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

win_probabilitynumber or null

The probability of winning the opportunity, expressed as a percentage.

close_datestring or null

The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.

loss_reason_idstring or null

The unique identifier of the reason why the opportunity was lost.

loss_reasonstring or null

The reason why the opportunity was lost.

won_reason_idstring or null

The unique identifier of the reason why the opportunity was won.

won_reasonstring or null

The reason why the opportunity was won.

pipeline_idstring or null

The unique identifier of the pipeline associated with the opportunity

pipeline_stage_idstring or null

The unique identifier of the stage in the pipeline associated with the opportunity.

source_idstring or null

The unique identifier of the source of the opportunity.

lead_idstring or null

The unique identifier of the lead associated with the opportunity.

lead_sourcestring or null

The source of the lead associated with the opportunity.

contact_idstring or null

The unique identifier of the contact associated with the opportunity.

contact_idsstrings

An array of unique identifiers of all contacts associated with the opportunity.

company_idstring or null

The unique identifier of the company associated with the opportunity.

company_namestring or null

The name of the company associated with the opportunity.

owner_idstring or null

The unique identifier of the user who owns the opportunity.

prioritystring or null

The priority level of the opportunity.

statusstring or null

The current status of the opportunity.

status_idstring or null

The unique identifier of the current status of the opportunity.

tagsstrings or null

custom_fieldsobjects

stage_last_changed_atstring or null

The date and time when the stage of the opportunity was last changed.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Opportunity updated

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "title": "New Rocket",
  "primary_contact_id": "12345",
  "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "type": "Existing Customer - Upgrade",
  "monetary_amount": 75000,
  "currency": "USD",
  "win_probability": 40,
  "close_date": "2020-10-30",
  "loss_reason_id": "12345",
  "loss_reason": "No budget",
  "won_reason_id": "12345",
  "won_reason": "Best pitch",
  "pipeline_id": "12345",
  "pipeline_stage_id": "12345",
  "source_id": "12345",
  "lead_id": "12345",
  "lead_source": "Website",
  "contact_id": "12345",
  "contact_ids": [
    "12345"
  ],
  "company_id": "12345",
  "company_name": "Copper",
  "owner_id": "12345",
  "priority": "None",
  "status": "Open",
  "status_id": "12345",
  "tags": [
    "New"
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "stage_last_changed_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete opportunity

delete

https://unify.apideck.com/crm/opportunities/{id}

Delete opportunity

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Opportunity deleted

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.opportunitiesDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Leads

The Leads model

idstring

Unique identifier for the contact.

namestring

required

Full name of the lead.

company_namestring or null

required

The name of the company the lead is associated with.

owner_idstring or null

The owner of the lead.

owner_namestring or null

The name of the owner of the lead.

company_idstring or null

The company the lead is associated with.

Leads example

{}

List leads

get

https://unify.apideck.com/crm/leads

List leads

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[name]=Elon Musk

Apply filters

sortobjectsort[by]=created_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

Responses

200Leads

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

ActiveCampaign

Close.io

Copper

Flexmail

Freshworks CRM

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Act

Request

Attio

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.leadsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "Elon Musk",
      "company_name": "Spacex",
      "owner_id": "54321",
      "owner_name": "John Doe",
      "company_id": "2",
      "lead_id": "2",
      "lead_source": "Cold Call",
      "first_name": "Elon",
      "last_name": "Musk",
      "description": "A thinker",
      "prefix": "Sir",
      "title": "CEO",
      "language": "EN",
      "status": "New",
      "monetary_amount": 75000,
      "currency": "USD",
      "fax": "+12129876543",
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "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",
          "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"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "custom_mappings": {},
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create lead

post

https://unify.apideck.com/crm/leads

Create lead

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring

required

Full name of the lead.

company_namestring or null

required

The name of the company the lead is associated with.

owner_idstring or null

The owner of the lead.

owner_namestring or null

The name of the owner of the lead.

company_idstring or null

The company the lead is associated with.

lead_idstring or null

The identifier of the lead.

lead_sourcestring or null

The source of the lead.

first_namestring or null

The first name of the lead.

last_namestring or null

The last name of the lead.

descriptionstring or null

The description of the lead.

prefixstring or null

The prefix of the lead.

titlestring or null

The job title of the lead.

languagestring or null

language code according to ISO 639-1. For the United States - EN

statusstring or null

monetary_amountnumber or null

The monetary amount of the lead.

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

faxstring or null

The fax number of the lead.

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

custom_fieldsobjects

tagsstrings or null

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Lead created

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

ActiveCampaign

Close.io

Copper

Flexmail

Freshworks CRM

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Act

Request

Attio

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "name": "Elon Musk",
  "company_name": "Spacex",
  "owner_id": "54321",
  "owner_name": "John Doe",
  "company_id": "2",
  "lead_id": "2",
  "lead_source": "Cold Call",
  "first_name": "Elon",
  "last_name": "Musk",
  "description": "A thinker",
  "prefix": "Sir",
  "title": "CEO",
  "language": "EN",
  "status": "New",
  "monetary_amount": 75000,
  "currency": "USD",
  "fax": "+12129876543",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get lead

get

https://unify.apideck.com/crm/leads/{id}

Get lead

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

Responses

200Lead

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

ActiveCampaign

Close.io

Copper

Flexmail

Freshworks CRM

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Act

Request

Attio

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.leadsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Elon Musk",
    "company_name": "Spacex",
    "owner_id": "54321",
    "owner_name": "John Doe",
    "company_id": "2",
    "lead_id": "2",
    "lead_source": "Cold Call",
    "first_name": "Elon",
    "last_name": "Musk",
    "description": "A thinker",
    "prefix": "Sir",
    "title": "CEO",
    "language": "EN",
    "status": "New",
    "monetary_amount": 75000,
    "currency": "USD",
    "fax": "+12129876543",
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "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",
        "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"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "custom_mappings": {},
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update lead

patch

https://unify.apideck.com/crm/leads/{id}

Update lead

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring

required

Full name of the lead.

company_namestring or null

required

The name of the company the lead is associated with.

owner_idstring or null

The owner of the lead.

owner_namestring or null

The name of the owner of the lead.

company_idstring or null

The company the lead is associated with.

lead_idstring or null

The identifier of the lead.

lead_sourcestring or null

The source of the lead.

first_namestring or null

The first name of the lead.

last_namestring or null

The last name of the lead.

descriptionstring or null

The description of the lead.

prefixstring or null

The prefix of the lead.

titlestring or null

The job title of the lead.

languagestring or null

language code according to ISO 639-1. For the United States - EN

statusstring or null

monetary_amountnumber or null

The monetary amount of the lead.

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

faxstring or null

The fax number of the lead.

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

custom_fieldsobjects

tagsstrings or null

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Lead updated

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

ActiveCampaign

Close.io

Copper

Flexmail

Freshworks CRM

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Act

Request

Attio

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

{
  "name": "Elon Musk",
  "company_name": "Spacex",
  "owner_id": "54321",
  "owner_name": "John Doe",
  "company_id": "2",
  "lead_id": "2",
  "lead_source": "Cold Call",
  "first_name": "Elon",
  "last_name": "Musk",
  "description": "A thinker",
  "prefix": "Sir",
  "title": "CEO",
  "language": "EN",
  "status": "New",
  "monetary_amount": 75000,
  "currency": "USD",
  "fax": "+12129876543",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete lead

delete

https://unify.apideck.com/crm/leads/{id}

Delete lead

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Lead deleted

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

ActiveCampaign

Close.io

Copper

Flexmail

HubSpot

Microsoft Dynamics CRM

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Act

Request

Attio

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Outlook

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.leadsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Contacts

The Contacts model

idstring

Unique identifier for the contact.

namestring or null

required

Full name of the contact.

owner_idstring or null

The owner of the contact.

typestring or null

Enum:customersupplieremployeepersonal

The type of the contact.

company_idstring or null

The company the contact is associated with.

company_namestring or null

The name of the company the contact is associated with.

Contacts example

{}

List contacts

get

https://unify.apideck.com/crm/contacts

List contacts

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

filterobjectfilter[name]=Elon Musk

Apply filters

sortobjectsort[by]=created_at

Apply sorting

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

Responses

200Contacts

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

Flexmail

Google Contacts

HubSpot

Microsoft Dynamics CRM

Microsoft Outlook

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Freshworks CRM

Request

Holded

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.contactsAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "contacts",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "name": "Elon Musk",
      "owner_id": "54321",
      "type": "personal",
      "company_id": "23456",
      "company_name": "23456",
      "lead_id": "34567",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "prefix": "Mr.",
      "suffix": "PhD",
      "title": "CEO",
      "department": "Engineering",
      "language": "EN",
      "gender": "female",
      "birthday": "2000-08-12",
      "image": "https://unavatar.io/elon-musk",
      "photo_url": "https://unavatar.io/elon-musk",
      "lead_source": "Cold Call",
      "fax": "+12129876543",
      "description": "Internal champion",
      "current_balance": 10.5,
      "status": "open",
      "active": true,
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "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",
          "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"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "country_code": "1",
          "area_code": "323",
          "number": "111-111-1111",
          "extension": "105",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "email_domain": "gmail.com",
      "custom_fields": [
        {
          "id": "2389328923893298",
          "name": "employee_level",
          "description": "Employee Level",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "first_call_at": "2020-09-30T07:43:32.000Z",
      "first_email_at": "2020-09-30T07:43:32.000Z",
      "last_activity_at": "2020-09-30T07:43:32.000Z",
      "custom_mappings": {},
      "updated_at": "2017-08-12T20:43:21.291Z",
      "created_at": "2017-08-12T20:43:21.291Z",
      "opportunity_ids": [
        "12345"
      ]
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create contact

post

https://unify.apideck.com/crm/contacts

Create contact

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring or null

required

Full name of the contact.

owner_idstring or null

The owner of the contact.

typestring or null

Enum:customersupplieremployeepersonal

The type of the contact.

company_idstring or null

The company the contact is associated with.

company_namestring or null

The name of the company the contact is associated with.

lead_idstring or null

The lead the contact is associated with.

first_namestring or null

The first name of the contact.

middle_namestring or null

The middle name of the contact.

last_namestring or null

The last name of the contact.

prefixstring or null

The prefix of the contact.

suffixstring or null

The suffix of the contact.

titlestring or null

The job title of the contact.

departmentstring or null

The department of the contact.

languagestring or null

language code according to ISO 639-1. For the United States - EN

genderstring or null

Enum:malefemaleunisex

The gender of the contact.

birthdaystring or null

The birthday of the contact.

imagestring or null

deprecated

photo_urlstring or null

The URL of the photo of a person.

lead_sourcestring or null

The lead source of the contact.

faxstring or null

The fax number of the contact.

descriptionstring or null

The description of the contact.

current_balancenumber or null

The current balance of the contact.

statusstring or null

The status of the contact.

activeboolean or null

The active status of the contact.

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

email_domainstring or null

custom_fieldsobjects

tagsstrings or null

opportunity_idsstrings

The opportunity ids of the contact.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

201Contact created

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

Flexmail

Google Contacts

HubSpot

Microsoft Dynamics CRM

Microsoft Outlook

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Freshworks CRM

Request

Holded

Request

Request example

{
  "name": "Elon Musk",
  "owner_id": "54321",
  "type": "personal",
  "company_id": "23456",
  "company_name": "23456",
  "lead_id": "34567",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "prefix": "Mr.",
  "suffix": "PhD",
  "title": "CEO",
  "department": "Engineering",
  "language": "EN",
  "gender": "female",
  "birthday": "2000-08-12",
  "image": "https://unavatar.io/elon-musk",
  "photo_url": "https://unavatar.io/elon-musk",
  "lead_source": "Cold Call",
  "fax": "+12129876543",
  "description": "Internal champion",
  "current_balance": 10.5,
  "status": "open",
  "active": true,
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "email_domain": "gmail.com",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "opportunity_ids": [
    "12345"
  ],
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "contacts",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}

Get contact

get

https://unify.apideck.com/crm/contacts/{id}

Get contact

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

filterobjectfilter[name]=Elon Musk

Apply filters

Responses

200Contact

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

Flexmail

Google Contacts

HubSpot

Microsoft Dynamics CRM

Microsoft Outlook

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Freshworks CRM

Request

Holded

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.contactsOne({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Elon Musk",
    "owner_id": "54321",
    "type": "personal",
    "company_id": "23456",
    "company_name": "23456",
    "lead_id": "34567",
    "first_name": "Elon",
    "middle_name": "D.",
    "last_name": "Musk",
    "prefix": "Mr.",
    "suffix": "PhD",
    "title": "CEO",
    "department": "Engineering",
    "language": "EN",
    "gender": "female",
    "birthday": "2000-08-12",
    "image": "https://unavatar.io/elon-musk",
    "photo_url": "https://unavatar.io/elon-musk",
    "lead_source": "Cold Call",
    "fax": "+12129876543",
    "description": "Internal champion",
    "current_balance": 10.5,
    "status": "open",
    "active": true,
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "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",
        "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"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "country_code": "1",
        "area_code": "323",
        "number": "111-111-1111",
        "extension": "105",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "email_domain": "gmail.com",
    "custom_fields": [
      {
        "id": "2389328923893298",
        "name": "employee_level",
        "description": "Employee Level",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "first_call_at": "2020-09-30T07:43:32.000Z",
    "first_email_at": "2020-09-30T07:43:32.000Z",
    "last_activity_at": "2020-09-30T07:43:32.000Z",
    "custom_mappings": {},
    "updated_at": "2017-08-12T20:43:21.291Z",
    "created_at": "2017-08-12T20:43:21.291Z",
    "opportunity_ids": [
      "12345"
    ]
  }
}

Update contact

patch

https://unify.apideck.com/crm/contacts/{id}

Update contact

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

namestring or null

required

Full name of the contact.

owner_idstring or null

The owner of the contact.

typestring or null

Enum:customersupplieremployeepersonal

The type of the contact.

company_idstring or null

The company the contact is associated with.

company_namestring or null

The name of the company the contact is associated with.

lead_idstring or null

The lead the contact is associated with.

first_namestring or null

The first name of the contact.

middle_namestring or null

The middle name of the contact.

last_namestring or null

The last name of the contact.

prefixstring or null

The prefix of the contact.

suffixstring or null

The suffix of the contact.

titlestring or null

The job title of the contact.

departmentstring or null

The department of the contact.

languagestring or null

language code according to ISO 639-1. For the United States - EN

genderstring or null

Enum:malefemaleunisex

The gender of the contact.

birthdaystring or null

The birthday of the contact.

imagestring or null

deprecated

photo_urlstring or null

The URL of the photo of a person.

lead_sourcestring or null

The lead source of the contact.

faxstring or null

The fax number of the contact.

descriptionstring or null

The description of the contact.

current_balancenumber or null

The current balance of the contact.

statusstring or null

The status of the contact.

activeboolean or null

The active status of the contact.

websitesobjects

addressesobjects

social_linksobjects

phone_numbersobjects

emailsobjects

email_domainstring or null

custom_fieldsobjects

tagsstrings or null

opportunity_idsstrings

The opportunity ids of the contact.

pass_throughobjects

The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.

Responses

200Contact updated

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

Flexmail

Google Contacts

HubSpot

Microsoft Dynamics CRM

Microsoft Outlook

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Freshworks CRM

Request

Holded

Request

Request example

{
  "name": "Elon Musk",
  "owner_id": "54321",
  "type": "personal",
  "company_id": "23456",
  "company_name": "23456",
  "lead_id": "34567",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "prefix": "Mr.",
  "suffix": "PhD",
  "title": "CEO",
  "department": "Engineering",
  "language": "EN",
  "gender": "female",
  "birthday": "2000-08-12",
  "image": "https://unavatar.io/elon-musk",
  "photo_url": "https://unavatar.io/elon-musk",
  "lead_source": "Cold Call",
  "fax": "+12129876543",
  "description": "Internal champion",
  "current_balance": 10.5,
  "status": "open",
  "active": true,
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "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",
      "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"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "email_domain": "gmail.com",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "opportunity_ids": [
    "12345"
  ],
  "pass_through": [
    {
      "service_id": "string",
      "operation_id": "string",
      "extend_object": {},
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "contacts",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}

Delete contact

delete

https://unify.apideck.com/crm/contacts/{id}

Delete contact

Authorizations:

apiKey

Path parameters

idstring

required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Contact deleted

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

Act

ActiveCampaign

Close.io

Copper

Flexmail

HubSpot

Microsoft Dynamics CRM

Microsoft Outlook

Pipedrive

Salesflare

Salesforce

Teamleader

Zendesk Sell

Zoho CRM

Attio

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.contactsDelete({
    id: 'id_example'
  })
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "contacts",
  "operation": "delete",
  "data": {
    "id": "12345"
  }
}

Pipelines

The Pipelines model

idstring

The unique identifier of the Pipeline.

namestringnon-empty

required

The name of the Pipeline.

currencystring or null

Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

archivedboolean

Whether the Pipeline is archived or not.

activeboolean

Whether the Pipeline is active or not.

display_orderinteger or null

The order in which the Pipeline is displayed in the UI.

Pipelines example

{}

List pipelines

get

https://unify.apideck.com/crm/pipelines

List pipelines

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]

Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

Responses

200Pipelines

400Bad Request

401Unauthorized

402Payment Required

404The specified resource was not found

422Unprocessable

Mapping coverage per connector

HubSpot

Pipedrive

Salesforce

Act

Request

ActiveCampaign

Request

Attio

Request

Close.io

Request

Copper

Request

Flexmail

Request

Freshworks CRM

Request

Google Contacts

Request

Holded

Request

Microsoft Dynamics CRM

Request

Microsoft Outlook

Request

Salesflare

Request

Teamleader

Request

Zendesk Sell

Request

Zoho CRM

Request

Request example

Node

import { Apideck } from '@apideck/node'

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
})

try {
  const { data } = await apideck.crm.pipelinesAll({})
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "pipelines",
  "operation": "all",
  "data": [
    {
      "id": "default",
      "name": "Sales Pipeline",
      "currency": "USD",
      "archived": false,
      "active": false,
      "display_order": 1,
      "win_probability_enabled": true,
      "stages": [
        {
          "id": "contractsent",
          "name": "Contract Sent",
          "value": "CONTRACT_SENT",
          "win_probability": 50,
          "display_order": 1
        }
      ],
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create pipeline
Upcoming

post

https://unify.apideck.com/crm/pipelines

Create pipeline

Authorizations:

apiKey

Header parameters

x-apideck-consumer-idstring

required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring

required

The ID of your Unify application

x-apideck-service-idstring

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

rawboolean

Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json

CRM API Reference

Introduction

Base URL

Headers

Authorization

apiKey

applicationId

consumerId

Pagination

Query Parameters

Response Body

SDKs and API Clients

Debugging

Errors

Handling errors

Error Types

RequestValidationError

UnsupportedFiltersError

UnsupportedSortFieldError

InvalidCursorError

ConnectorExecutionError

UnauthorizedError

ConnectorCredentialsError

ConnectorDisabledError

ConnectorRateLimitError

RequestLimitError

EntityNotFoundError

OAuthCredentialsNotFoundError

IntegrationNotFoundError

ConnectionNotFoundError

ConnectionSettingsError

ConnectorNotFoundError

OAuthRedirectUriError

OAuthInvalidStateError

OAuthCodeExchangeError

OAuthConnectorError

MappingError

ConnectorMappingNotFoundError

ConnectorResponseMappingNotFoundError

ConnectorOperationMappingNotFoundError

ConnectorWorkflowMappingError

ConnectorOperationUnsupportedError

PaginationNotSupportedError

API Design

API Styles and data formats

REST API

Available HTTP methods

Schema

Meta

Request IDs

Fixed field types

Dates

Prices and Currencies

Support

Static IP

Companies

The Companies model

List companies

Header parameters

Query parameters

Responses

Mapping coverage per connector

Create company

Header parameters

Query parameters

Request body schema

Responses

Mapping coverage per connector

Get company

Path parameters

Header parameters

Query parameters

Responses

Mapping coverage per connector

Update company

Path parameters

Header parameters

Query parameters

Request body schema

Responses