API Changelog

v6.0.0 - (2021-10-14)

Webhook API

Added beta version of the Webhook API.

v5.12.1 - (2021-10-13)

Vault API

Connection.form_fields is readOnly. The values should be sent via Connection.settings when mutating a connection.

v5.12.0 - (2021-09-16)

Extended phone number resource with country_code, area_code, and new direct-dial-in type

Accounting API

Mapped Xero customers

File Storage API

Added the Dropbox and Box connectors

v5.11.0 - (2021-09-15)

File Storage API

Added /file-storage/files/search endpoint.
Added the Sharepoint and OneDrive connectors

v5.10.0 - (2021-09-13)

File Storage API

Renamed folderId filter to folder_id
Add shared filter to the Files resource

v5.9.1 - (2021-09-08)

File Storage API

Added filter on folderId to the Files resource.

v5.8.1 - (2021-09-08)

Proxy API

Added support for responses larger than 6MB. For more information, see the Proxy API docs.

v5.8.0 - (2021-09-08)

File Storage API

Added beta version of the File Storage API and the Google Drive connector.

v5.7.0 - (2021-09-06)

Add Company info resource. Replace Contact and Company resource by Customer resource.

v5.6.0 - (2021-09-06)

Accounting API

Add Customers resource.

v5.5.1 - (2021-08-29)

Accounting API

Rename general_ledger_account to ledger_account read-only on Invoices.

v5.4.1 - (2021-08-27)

Accounting, CRM, Lead & Vault API

normlized the naming of definitions
fixed response descriptions to match shared definitions and avoid duplicates

v5.4.0 - (2021-08-25)

CRM API

Make duration_minutes read-only on Activities.

v5.3.0 - (2021-08-19)

Vault API

Add custom_consumer_settings to create session. Allow wildcard objects to be passed through the metadata field on a connection.

v5.2.0 - (2021-08-15)

CRM API

Add contact_id, company_id, opportunity_id, lead_id, and active to Notes.

v5.1.0 - (2021-08-13)

Accounting API

Added alpha version of the Accounting API and the MYOB connector.

Supported resources:

Ledger Accounts
Tax Rates
Invoices
Contacts
Companies

v5.0.1 - (2021-08-11)

CRM, Lead & Vault API

For all error responses, typeName was renamed to type_name for consistency.

v5.0.0 - (2021-08-01)

CRM & Lead API

expected_revenue, type, last_activity_at, lead_source, and stage_last_changed_at added to Opportunity resource
annual_revenue, number_of_employees, industry, last_activity_at, ownership, and parent_id added to Company resource
Renamed image_url to image on the Company resource
Remove tax on the Company resource, since it's already present in phone_numbers
image, last_activity_at, first_email_at, and first_call_at added to Contact resource

v4.3.3 - (2021-07-29)

Vault API

vault/callback: Added code parameter

v4.3.2 - (2021-07-23)

Vault API

Connection.json#updated_at is nullable
vault/logs filter for exclude_unified_apis has been refactored to be comma separated string

v4.3.1 - (2021-07-15)

Vault API

Added ability to filter log results in vault.

v4.3.0 - (2021-07-14)

Vault API

New /vault/logs endpoint released to enable fetching paginated list of request logs scoped to application and consumer.

v4.2.0 - (2021-07-07)

Vault API

Added a services array to list all active services when listing all consumers.

v4.1.1 - (2021-07-05)

CRM API & Lead API & Vault API

extend examples for fields that allow anyOf (in this case errors that allow strings or objects)

v4.1.0 - (2021-07-02)

CRM API

Added sorting support to Leads, Companies and Opportunities. To sort results, use the sort[by] and sort[direction] query parameters.
- Leads: available sort[by] values are name, first_name, last_name, email, created_at and updated_at.
- Companies: available sort[by] values are name, created_at and updated_at.
- Opportunities: available sort[by] values are title, status, monetary_amount, win_probability,created_at and updated_at.

v4.0.0 - (2021-07-01)

CRM API

Added note and task as allowed values for type on the activity resource
activity_datetime and duration_seconds are no longer required on the activity resource

ACTION REQUIRED

CRM API

Beta users should note the following breaking changes that may affect existing integrations implementing the CRM API:

On the activity resource, following fields were removed:
- recurrence_activity_id
- recurrence_start_datetime
- recurrence_end_date
- recurrence_timezone
- recurrence_interval
- recurrence_day_of_week_mask
- recurrence_day_of_month
- recurrence_instance
- recurrence_month_of_year
- recurrence_end_date_only
- recurrence_type

v3.0.3 - (2021-07-01)

CRM API & Lead API & Vault API

detail property on all errors can be a string or and object

v3.0.2 - (2021-06-29)

CRM API & Lead API & Vault API

all required fields are validated with minLength: 1

v3.0.1 - (2021-06-28)

CRM API & Lead API

lead_source and language added to Lead resource
account_id and duration_in_minutes added to Activity resource

v3.0.0 - (2021-06-18)

ACTION REQUIRED

Vault API

Beta users should note the following breaking changes that may affect existing integrations implementing the Vault API:

Moved api_key field from the root in the request body to the settings object when creating/updating connections.

v2.4.0 - (2021-06-08)

CRM API

Added sorting support to Contacts. To sort Contacts, use the sort[by] and sort[direction] query parameters. Available sort[by] values are name, first_name, last_name, email, created_at and updated_at.

v2.3.0 - (2021-06-07)

CRM API & Lead API

Remove connectors table

v2.2.0 - (2021-06-07)

Proxy API

Documented static IP and limitations

v2.1.0 - (2021-05-31)

Vault API

Undocumented connectionsAdd added
Normalized reponses for connectionsGetSettings and connectionsUpdateSettings

v2.0.0 - (2021-05-28)

Vault/Proxy API

Deprecated /vault/proxy and moved to the Proxy API

v1.10.0 - (2021-05-28)

CRM API

Added filter query parameter for opportunity

v1.9.0 - (2021-05-26)

CRM API

Added filter query parameter for lead

v1.8.0 - (2021-05-24)

CRM API

Added Activities resource

v1.7.0 - (2021-05-21)

CRM API

Added Users resource

v1.6.0 - (2021-05-20)

CRM API

Added Notes resource

v1.5.0 - (2021-05-19)

Configuration options per resource extended to fetch dynamic options when configuring settings.

Vault API

Added filter-type to FormField.type that allows configuration options to be filtered by the value of a separate setting.
FormFieldOptionGroup schema added to define grouping of options within a FormField

1.4.0

v1.4.0 - (2021-05-18)

Added configuration options per resource.

1.4.0

Vault API

Renamed schema_support to resource_schema_support and introduced resource_settings_support to the connection settings endpoint
Add configurable_resources to the connections endpoint

v1.3.0 - (2021-05-13)

Apideck APIs now use a single semver version for clarity.

1.3.0

CRM API & Lead API

SpecRequestValidationError was replaced by 2 more helpful errors. RequestBodyValidationError and RequestParametersValidationError are more readable, informative and provide suggestions.

v1.2.0 - (2021-05-12)

New consumer endpoints added to the Vault API providing a list and aggregate data on the type of requests consumers are making.

Vault 1.2.0

/vault/consumers added to provide paginated list of consumers scoped to application
/vault/consumers/{consumer_id} added to provide consumer detail including aggregated_request_count and request counts across the Unified APIs.
/vault/consumers/{consumer_id}/stats added to provide request count aggregation data within a datetime range.

v1.1.1 - (2021-05-10)

Initial spec of new Vault Consumers API drafted for upcoming release.

Vault 1.1.1

v1.1.0 - (2021-04-23)

We switched to a dynamic way of using filters instead of fixed query parameters.

ACTION REQUIRED

CRM 1.1.0

Beta users should note the following breaking changes that may affect existing integrations implementing the CRM API:

Filtering on contacts has now a dedicated filter query parameter instead of seperated query parameters per field
Filtering on opportunities has now a dedicated filter query parameter instead of seperated query parameters per field

v1.0.0 - (2021-04-21)

Moving towards widespread public release, we're updating our specs to version 1.0.0 across the board. This acts as a starting point to officially implement semantic versioning across all of our specs.

From here on in, we'll be tracking, documenting and broadcasting implemented or upcoming API changes within this document.

ACTION REQUIRED

CRM 1.0.0 Lead 1.0.0

Beta users should note the following breaking changes that may affect existing integrations implementing either Lead or CRM API:

Address.type enum updated to ["primary", "secondary", "home", "office", "shipping", "billing", "other"]
Website.category has been renamed to Website.type and is now an enum. Now accepts: ["primary", "secondary", "work", "personal", "other"]
Email.type migrated from string to enum. Now accepts: ["primary", "secondary", "work", "personal", "billing", "other"]
PhoneNumber.phone_type changed to PhoneNumber.type and enum now accepts: ["primary", "secondary", "home", "office", "mobile", "assistant", "fax", "other"].

Note: All enums that previously accepted default now expect primary!