CRM API
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |
| Authorization | String | Yes | Bearer KEY |
Authorization
You can interact with the API through the authorization methods below.
-->
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 … |
Endpoints 53
Activities
- GETList activities
/crm/activities?raw=false&cursor=string&limit=20&filter={"updated_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList activities - POSTCreate activity
/crm/activities?raw=falseCreate activity - GETGet activity
/crm/activities/:id?raw=false&fields=id,updated_atGet activity - DELETEDelete activity
/crm/activities/:id?raw=falseDelete activity - PATCHUpdate activity
/crm/activities/:id?raw=falseUpdate activity
Companies
- GETList companies
/crm/companies?raw=false&cursor=string&limit=20&filter={"name":"SpaceX","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList companies - POSTCreate company
/crm/companies?raw=falseCreate company - GETGet company
/crm/companies/:id?raw=false&fields=id,updated_atGet company - DELETEDelete company
/crm/companies/:id?raw=falseDelete company - PATCHUpdate company
/crm/companies/:id?raw=falseUpdate company
Contacts
- GETList contacts
/crm/contacts?raw=false&cursor=string&limit=20&filter={"first_name":"Elon","last_name":"Musk","email":"elon@tesla.com","company_id":"12345","owner_id":"12345","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList contacts - POSTCreate contact
/crm/contacts?raw=falseCreate contact - GETGet contact
/crm/contacts/:id?raw=false&fields=id,updated_at&filter={"first_name":"Elon","last_name":"Musk","email":"elon@tesla.com","company_id":"12345","owner_id":"12345","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}Get contact - DELETEDelete contact
/crm/contacts/:id?raw=falseDelete contact - PATCHUpdate contact
/crm/contacts/:id?raw=falseUpdate contact
Leads
- GETList leads
/crm/leads?raw=false&cursor=string&limit=20&filter={"first_name":"Elon","last_name":"Musk","email":"elon@tesla.com","phone_number":"1234567890"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList leads - POSTCreate lead
/crm/leads?raw=falseCreate lead - GETGet lead
/crm/leads/:id?raw=false&fields=id,updated_atGet lead - DELETEDelete lead
/crm/leads/:id?raw=falseDelete lead - PATCHUpdate lead
/crm/leads/:id?raw=falseUpdate lead
Lists
- GETList lists
/crm/lists?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList lists - GETGet list
/crm/lists/:id?raw=false&fields=id,updated_atGet list
ListMembers
- GETList list members
/crm/lists/:id/members?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atRetrieve the records that belong to a List. Returns a paginated set of members, each carrying the downstream record id and its object_type. Use this to…
Notes
- GETList notes
/crm/notes?raw=false&cursor=string&limit=20&filter={"title":"Follow up call"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList notes - POSTCreate note
/crm/notes?raw=falseCreate note - GETGet note
/crm/notes/:id?raw=false&fields=id,updated_atGet note - DELETEDelete note
/crm/notes/:id?raw=falseDelete note - PATCHUpdate note
/crm/notes/:id?raw=falseUpdate note
Opportunities
- GETList opportunities
/crm/opportunities?raw=false&cursor=string&limit=20&filter={"status":"Completed","monetary_amount":75000}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList opportunities - POSTCreate opportunity
/crm/opportunities?raw=falseCreate opportunity - GETGet opportunity
/crm/opportunities/:id?raw=false&fields=id,updated_atGet opportunity - DELETEDelete opportunity
/crm/opportunities/:id?raw=falseDelete opportunity - PATCHUpdate opportunity
/crm/opportunities/:id?raw=falseUpdate opportunity
Pipelines
- GETList pipelines
/crm/pipelines?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList pipelines - POSTCreate pipeline
/crm/pipelines?raw=falseCreate pipeline - GETGet pipeline
/crm/pipelines/:id?raw=false&fields=id,updated_atGet pipeline - DELETEDelete pipeline
/crm/pipelines/:id?raw=falseDelete pipeline - PATCHUpdate pipeline
/crm/pipelines/:id?raw=falseUpdate pipeline
Users
- GETList users
/crm/users?raw=false&cursor=string&limit=20&filter={"email":"elon@apideck.com"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList users - POSTCreate user
/crm/users?raw=falseCreate user - GETGet user
/crm/users/:id?raw=false&fields=id,updated_atGet user - DELETEDelete user
/crm/users/:id?raw=falseDelete user - PATCHUpdate user
/crm/users/:id?raw=falseUpdate user
Custom Object Schemas
- GETList custom object schemas
/crm/custom-object-schemas?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}List custom object schemas - POSTCreate custom object schema
/crm/custom-object-schemas?raw=falseCreate custom object schema - GETGet custom object schema
/crm/custom-object-schemas/:id?raw=falseGet custom object schema - DELETEDelete custom object schema
/crm/custom-object-schemas/:id?raw=falseDelete custom object schema - PATCHUpdate custom object schema
/crm/custom-object-schemas/:id?raw=falseUpdate custom object schema
Custom Objects
- GETList custom objects
/crm/custom-objects/:object_id?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_atList custom objects - POSTCreate custom object
/crm/custom-objects/:object_id?raw=falseCreate custom object - GETGet custom object
/crm/custom-objects/:object_id/:id?raw=falseGet custom object - DELETEDelete custom object
/crm/custom-objects/:object_id/:id?raw=falseDelete custom object - PATCHUpdate custom object
/crm/custom-objects/:object_id/:id?raw=falseUpdate custom object
API details
- Base URL
https://unify.apideck.com- Authentication
- An API key in the Authorization header
An API key in the x-apideck-app-id header
An API key in the x-apideck-consumer-id header - Operations
- 53 operations on 23 pathsGET 23POST 10PATCH 10DELETE 10
- Main resources
- Activities 5Companies 5Contacts 5Custom Object Schemas 5Custom Objects 5Leads 5Notes 5Opportunities 5Pipelines 5Users 5
- Description format
- OpenAPI 3.0.3, API version
10.83.0 - Links
- Documentation · OpenAPI document · Support
How to test the CRM API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the CRM API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List activities” (GET /crm/activities?raw=false&cursor=string&limit=20&filter={"updated_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the CRM API?
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… It is listed under Developer tools and has 53 endpoints.
Who publishes the CRM API?
It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.
What is the base URL of the CRM API?
Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.
How do I authenticate with the CRM API?
It accepts 3 methods: an API key in the Authorization header; an API key in the x-apideck-app-id header; an API key in the x-apideck-consumer-id header.
How many endpoints does the CRM API have?
53 operations on 23 paths (23 GET, 10 POST, 10 PATCH, 10 DELETE). The largest groups are Activities, Companies, Contacts, Custom Object Schemas.
Is forking the CRM API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.