Introduction

❗️

IMPORTANT: Breaking Changes to the Unit21 API

We are making enhancements to the API that could affect your integration:

  • Unit21 ID and its associated fields (like previously_existed) will be deprecated for Entity, Events, and Instrument objects.
  • The API, webhooks, and exports will no longer process or return Unit21 ID or related fields for these three objects.
  • The List Entities, Events, and Instruments endpoints will be deprecated.

Your integration may be affected if you utilize any of the APIs, webhooks, or exports listed here: https://docs.unit21.ai/page/api-changes

Action Required: Please check and update your integration by September 30, 2023.

The Unit21 API enables you to integrate your systems with our services. Our API follows the REST convention and accepts and returns JSON data.

All requests should use the appropriate API URL which can be found at:

  • Production 1: https://api.unit21.com
  • Production 2: https://api.prod2.unit21.com
  • Production 3: https://api.prod1.eu-central-1.unit21.com
  • Sandbox 1: https://sandbox1-api.unit21.com
  • Sandbox 2: https://sandbox2-api.unit21.com
  • Sandbox 3: https://api.sandbox1.eu-central-1.unit21.com

All API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail - see the Authentication section for information on correctly authenticating calls to the Unit21 API.

📘

Unit21 ONLY SUPPORTS UTF-8 ENCODING!

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Charset

API Response Time

Response times across all object create/update endpoints:

  • p95 of <1000ms
  • p50 of <100ms