The Apideck CRM API is a unified API for managing customer relationships through opportunities, companies, leads, contacts, pipelines, notes, and activities across multiple CRM platforms such as Salesforce, HubSpot, Pipedrive, and Zoho CRM.
openapi: 3.0.3
info:
version: 10.24.12
title: Apideck CRM API
description: "Welcome to the CRM API.\n\nYou can use this API to access all CRM API endpoints.\n\n## Base URL\n\nThe base URL for all API requests is `https://unify.apideck.com`\n\n## Headers\n\nCustom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.\n\n| Name | Type | Required | Description |\n| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n| 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. |\n| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |\n| Authorization | String | Yes | Bearer <token> KEY |\n\n## Authorization\n\nYou can interact with the API through the authorization methods below.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n## Pagination\n\nAll API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional `cursor` and `limit` parameters.\n\nTo 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.\n\nIn 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.\n\n### Query Parameters\n\n| Name | Type | Required | Description |\n| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |\n| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |\n| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |\n\n### Response Body\n\n| Name | Type | Description |\n| --------------------- | ------ | ------------------------------------------------------------------ |\n| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |\n| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |\n| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |\n| meta.items_on_page | Number | Number of items returned in the data property of the response |\n| links.previous | String | Link to navigate to the previous page of results through the API |\n| links.current | String | Link to navigate to the current page of results through the API |\n| links.next | String | Link to navigate to the next page of results through the API |\n\n⚠️ `meta.cursors.previous`/`links.previous` is not available for all connectors.\n\n## SDKs and API Clients\n\nWe currently
offer a [Node.js](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php), [Python](https://developers.apideck.com/sdks/python) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK.\nNeed another SDK? [Request the SDK of your choice](https://requests.apideck.io/request).\n\n## Debugging\n\nBecause 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.\n\n## Errors\n\nThe 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.\n\n| Code | Title | Description |\n| ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 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. |\n| 201 | Created | The request has been fulfilled and has resulted in one or more new resources being created. |\n| 204 | No Content | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |\n| 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. |\n| 401 | Unauthorized | The request has not been applied because it lacks valid authentication credentials for the target resource. |\n| 402 | Payment Required | Subscription data is incomplete or out of date. You'll need to provide payment details to continue. |\n| 403 | Forbidden | You do not have the appropriate user rights to access the request. Do not repeat the request. |\n| 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. |\n| 409 | Conflict | The request could not be completed due to a conflict with the current state of the target resource. |\n| 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. |\n| 429 | Too Many Requests | You sent too many requests in a given amount of time (\"rate limit\"). Try again later |\n| 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. |\n\n### Handling errors\n\nThe 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.\n\n### Error Types\n\n#### RequestValidationError\n\nRequest 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.\n\n#### UnsupportedFiltersError\n\nFilters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.\n\n#### UnsupportedSortFieldError\n\nSort 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.\n\n#### InvalidCursorError\n\nPagination 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.\n\n#### ConnectorExecutionError\n\nA 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.\n\n#### UnauthorizedError\n\nWe 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 <API KEY>'`\n\n#### ConnectorCredentialsError\n\nA 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.\n\n#### ConnectorDisabledError\n\nA 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.\n\n#### ConnectorRateLimitError\n\nYou sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.\n\n#### RequestLimitError\n\nYou 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 [email protected] to continue making requests.\n\n#### EntityNotFoundError\n\nYou'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.\n\n#### OAuthCredentialsNotFoundError\n\nWhen 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.\n\n#### IntegrationNotFoundError\n\nThe 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.\n\n#### ConnectionNotFoundError\n\nA 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.\n\n#### ConnectionSettingsError\n\nThe connector has required settings that were not supplied. Verify `connection.settings` contains all required settings for the connector to be callable.\n\n#### ConnectorNotFoundError\n\nA 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`.\n\n#### OAuthRedirectUriError\n\nA 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.\n\n#### OAuthInvalidStateError\n\nThe 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.\n\n#### OAuthCodeExchangeError\n\nWhen 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.\n\n#### OAuthConnectorError\n\nIt 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.\n\n#### MappingError\n\nThere was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.\n\n#### ConnectorMappingNotFoundError\n\nIt 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.\n\n#### ConnectorResponseMappingNotFoundError\n\nWe 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.\n\n#### ConnectorOperationMappingNotFoundError\n\nConnector 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.\n\n#### ConnectorWorkflowMappingError\n\nThe 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.\n\n#### ConnectorOperationUnsupportedError\n\nYou'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.\n\n#### PaginationNotSupportedError\n\nPagination 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.\n\n## API Design\n\n### API Styles and data formats\n\n#### REST API\n\nThe API is organized around [REST](https://restfulapi.net/), 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.\n\n##### Available HTTP methods\n\nThe 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.\n\n```\nPOST /messages\nGET /messages\nGET /messages/{messageId}\nPATCH /messages/{messageId}\nDELETE /messages/{messageId}\n```\n\nResponse 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.\n\n### Schema\n\nAll 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.\n\n### Meta\n\nMeta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.\n\n### Request IDs\n\nEach 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.\n\n### Fixed field types\n\n#### Dates\n\nThe dates returned by the API are all represented in UTC (ISO8601 format).\n\nThis 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.\n\nThe 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.\n\n#### Currencies\n\nAll currency codes conform to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).\n\n## Support\n\nIf you have problems or need help with your case, you can always reach out to our Support.\n\n## Static IP\n\nSome 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.\nTo use this feature, the API Vendor will need to whitelist the associated static IP addresses.\nThe provided static IP addresses are fixed to their specified region and shared by all customers who use this feature.\n\n- EU Central 1: **18.197.244.247**, **18.156.9.3**, **3.65.139.215**\n- Other: upcoming\n\n More info about our data security can be found at [https://compliance.apideck.com/](https://compliance.apideck.com/)\n\n"
contact:
email: [email protected]
url: https://developers.apideck.com
x-logo:
url: https://developers.apideck.com/icon.png
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
x-apideck-api: crm
x-apideck-sdk-support: true
externalDocs:
description: Apideck Developer Docs
url: https://developers.apideck.com
servers:
- url: https://unify.apideck.com
description: Production
security:
- apiKey: []
applicationId: []
consumerId: []
tags:
- name: Activities
description: The Activity resource represents a logged event or task, such as a meeting, call, or email, including details like type, date, duration, and associations with contacts, companies, or opportunities.
x-apideck-resource-id: activities
x-apideck-model:
$ref: '#/components/schemas/Activity'
- name: Companies
description: The Companies resource provides detailed information about business entities, including key attributes such as name, contact details, and industry.
x-apideck-resource-id: companies
x-apideck-model:
$ref: '#/components/schemas/Company'
- name: Contacts
description: The Contact resource represents individuals, including details such as name, contact information, associated company, and activity history.
x-apideck-resource-id: contacts
x-apideck-model:
$ref: '#/components/schemas/Contact'
- name: Custom Object Schemas
description: The Custom Object Schema resource represents the schema of a custom object.
x-apideck-resource-id: custom-object-schemas
x-apideck-model:
$ref: '#/components/schemas/CustomObjectSchema'
- name: Custom Objects
description: The Custom Object resource represents user-defined data structures in Salesforce, allowing storage of custom records with specific fields, relationships, and business logic tailored to unique organizational needs.
x-apideck-resource-id: custom-objects
x-apideck-model:
$ref: '#/components/schemas/CustomObject'
- name: Leads
description: The Lead resource represents individuals or businesses that have shown interest in a company's products or services, including contact information and potential deal opportunities.
x-apideck-resource-id: leads
x-apideck-model:
$ref: '#/components/schemas/Lead'
- name: Notes
description: The Note resource represents textual records, such as comments or messages, associated with various entities like contacts, opportunities, or activities.
x-apideck-resource-id: notes
x-apideck-model:
$ref: '#/components/schemas/Note'
- name: Opportunities
description: The Opportunity resource represents potential business deals, including details such as title, value, status, close date, and associated contacts or companies.
x-apideck-resource-id: opportunities
x-apideck-model:
$ref: '#/components/schemas/Opportunity'
- name: Pipelines
description: The Pipeline resource represents a structured process for managing sales opportunities, including stages and associated activities.
x-apideck-resource-id: pipelines
x-apideck-model:
$ref: '#/components/schemas/Pipeline'
- name: Users
description: A User represents a CRM team member, including name, email, role, status, and associated permissions within the system.
x-apideck-resource-id: users
x-apideck-model:
$ref: '#/components/schemas/User'
components:
schemas:
ActivitiesFilter:
type: object
x-apideck-schema-id: ActivitiesFilter
example:
updated_since: '2020-09-30T07:43:32.000Z'
properties:
company_id:
type: string
description: Company ID to filter on
example: '1234'
owner_id:
type: string
description: Owner ID to filter on
example: '1234'
contact_id:
type: string
description: Primary contact ID to filter on
example: '1234'
updated_since:
type: string
title: Updated since (timestamp)
format: date-time
example: '2020-09-30T07:43:32.000Z'
type:
type: string
title: Type
description: Type to filter on
format: string
example: Task
additionalProperties: false
ActivitiesSort:
type: object
x-apideck-schema-id: ActivitiesSort
example:
by: created_at
direction: desc
properties:
by:
type: string
x-apideck-enum-id: activities.sort_by
description: The field on which to sort the Activities
enum:
- created_at
- updated_at
example: created_at
direction:
$ref: '#/components/schemas/SortDirection'
additionalProperties: false
Activity:
type: object
x-apideck-schema-id: Activity
additionalProperties: false
required:
- type
x-apideck-weights:
id: critical
downstream_id: edge-case
activity_datetime: high
duration_seconds: medium
user_id: edge-case
account_id: edge-case
contact_id: edge-case
company_id: edge-case
lead_id: edge-case
opportunity_id: edge-case
owner_id: high
campaign_id: edge-case
case_id: edge-case
asset_id: edge-case
contract_id: edge-case
product_id: edge-case
solution_id: edge-case
custom_object_id: edge-case
type: critical
title: critical
description: medium
note: medium
location: medium
location_address: medium
all_day_event: medium
private: low
group_event: edge-case
event_sub_type: medium
group_event_type: edge-case
child: low
archived: low
deleted: low
show_as: edge-case
done: medium
start_datetime: high
end_datetime: high
duration_minutes: edge-case
activity_date: medium
end_date: medium
attendees: edge-case
reminder_set: edge-case
reminder_datetime: edge-case
video_conference_url: edge-case
video_conference_id: edge-case
updated_at: high
properties:
id:
description: The unique identifier of the activity
type: string
readOnly: true
example: '12345'
downstream_id:
type: string
description: The third-party API ID of original entity
example: '12345'
nullable: true
readOnly: true
activity_datetime:
description: The date and time of the activity
type: string
example: '2021-05-01T12:00:00.000Z'
nullable: true
duration_seconds:
description: The duration of the activity in seconds
type: integer
example: 1800
minimum: 0
nullable: true
user_id:
description: The user related to the activity
type: string
example: '12345'
nullable: true
account_id:
description: The account related to the activity
type: string
example: '12345'
nullable: true
contact_id:
description: The contact related to the activity
type: string
example: '12345'
nullable: true
company_id:
description: The company related to the activity
type: string
example: '12345'
nullable: true
opportunity_id:
description: The opportunity related to the activity
type: string
example: '12345'
nullable: true
lead_id:
description: The lead related to the activity
type: string
example: '12345'
nullable: true
owner_id:
description: The owner of the activity
type: string
example: '12345'
nullable: true
campaign_id:
description: The campaign related to the activity
type: string
example: '12345'
nullable: true
case_id:
description: The case related to the activity
type: string
example: '12345'
nullable: true
asset_id:
description: The asset related to the activity
type: string
example: '12345'
nullable: true
contract_id:
description: The contract related to the activity
type: string
example: '12345'
nullable: true
product_id:
description: The product related to the activity
type: string
example: '12345'
nullable: true
solution_id:
description: The solution related to the activity
type: string
example: '12345'
nullable: true
custom_object_id:
description: The custom object related to the activity
type: string
example: '12345'
nullable: true
type:
description: The type of the activity
type: string
x-apideck-enum-id: activities.type
enum:
- call
- meeting
- email
- note
- task
- deadline
- send-letter
- send-quote
- other
example: meeting
nullable: true
title:
description: The title of the activity
type: string
example: Meeting
nullable: true
description:
description: A description of the activity
type: string
example: More info about the meeting
nullable: true
note:
description: An internal note about the activity
title: Note (internal)
type: string
example: An internal note about the meeting
nullable: true
location:
description: The location of the activity
type: string
example: Space
nullable: true
location_address:
$ref: '#/components/schemas/Address'
all_day_event:
description: Whether the Activity is an all day event or not
type: boolean
example: false
nullable: true
private:
description: Whether the Activity is private or not
type: boolean
example: true
nullable: true
group_event:
description: Whether the Activity is a group event or not
type: boolean
example: true
nullable: true
event_sub_type:
description: The sub type of the group event
type: string
example: debrief
nullable: true
group_event_type:
description: The type of the group event
type: string
example: Proposed
nullable: true
child:
description: Whether the activity is a child of another activity or not
type: boolean
example: false
nullable: true
archived:
description: Whether the activity is archived or not
type: boolean
example: false
nullable: true
deleted:
description: Whether the activity is deleted or not
type: boolean
example: false
nullable: true
show_as:
type: string
x-apideck-enum-id: activities.show_as
enum:
- free
- busy
example: busy
nullable: true
done:
title: Done
description: Whether the Activity is done or not
type: boolean
example: false
nullable: true
start_datetime:
description: The start date and time of the activity
type: string
example: '2021-05-01T12:00:00.000Z'
nullable: true
end_datetime:
description: The end date and time of the activity
type: string
example: '2021-05-01T12:30:00.000Z'
nullable: true
duration_minutes:
description: The duration of the activity in minutes
type: integer
example: 30
nullable: true
readOnly: true
activity_date:
description: The date of the activity
type: string
example: '2021-05-01'
nullable: true
end_date:
description: The end date of the activity
type: string
example: '2021-05-01'
nullable: true
recurrent:
description: Whether the activity is recurrent or not
type: boolean
example: false
reminder_datetime:
description: The date and time of the reminder
type: string
example: '2021-05-01T17:00:00.000Z'
nullable: true
reminder_set:
description: Whether the reminder is set or not
type: boolean
example: false
nullable: true
video_conference_url:
description: The URL of the video conference
title: Meeting URL
type: string
example: https://meet.example.com/j/88120759396
nullable: true
video_conference_id:
description: The ID of the video conference
title: Meeting ID
type: string
example: zoom:88120759396
nullable: true
custom_fields:
description: Custom fields of the activity
type: array
items:
$ref: '#/components/schemas/CustomField'
attendees:
type: array
items:
$ref: '#/components/schemas/ActivityAttendee'
custom_mappings:
$ref: '#/components/schemas/CustomMappings'
updated_by:
description: The user who last updated the activity
type: string
example: '12345'
readOnly: true
nullable: true
created_by:
description: The user who created the activity
type: string
example: '12345'
readOnly: true
nullable: true
updated_at:
description: The date and time when the activity was last updated
type: string
example: '2020-09-30T07:43:32.000Z'
readOnly: true
nullable: true
created_at:
descriptio
# --- truncated at 32 KB (352 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apideck/refs/heads/main/openapi/apideck-crm-openapi.yml