Skip to main content
The Nedzo API is organized around REST. It uses standard HTTP methods, returns JSON responses, and uses standard HTTP status codes.

​
Base URL

​
Authentication

All API requests require a Bearer token in the Authorization header:
See Authentication for more details.
If you’re using an account-scoped API key, most endpoints require a workspaceId in the request body or query string. Workspace-scoped keys infer it automatically. See Workspace ID and Request Scope for details on which to use and how to find your workspace ID.

​
Request Format

For POST, PUT, and PATCH requests, send JSON in the request body:

​
Response Format

All responses are JSON. Successful responses return the requested data:

​
Errors

Errors follow the RFC 7807 Problem Details format:

​
HTTP Status Codes

​
Pagination

List endpoints support pagination via query parameters:

​
Rate Limiting

Write requests on the public API (e.g. creating contacts, sending messages, triggering calls) are throttled per API key using a sustained-plus-burst model:
  • Sustained rate: 1 request per second.
  • Burst capacity: equal to your account’s concurrency limit. Requests above the burst capacity are rejected immediately, not queued.
When you exceed the limit, you’ll receive a 429 response with a Retry-After header (in seconds) indicating when you can retry. Read endpoints (GET) are not subject to this throttle. If you need a higher burst limit, contact support or your Nedzo account contact.