Getting Started

The NexaDesk API is a REST API that gives you programmatic access to your leads, contacts, and conversations. Use it to build integrations, sync data with other tools, or automate workflows.

Base URL

All API requests use this base URL:

https://chats.nexadesk.ai/api/v1/external

Authentication

Every request requires an API key passed as a Bearer token in the Authorization header:

Authorization: Bearer fc_live_xxxxxxxxxxxx

See Authentication for details on creating and managing API keys.

Request Format

• Content-Type: application/json for POST and PATCH requests
• Method: GET for reads, POST for creates, PATCH for updates, DELETE for deletes
• Query parameters: Used for filtering, sorting, and pagination on GET requests

Response Format

All responses follow this envelope format:

{
  "success": true,
  "data": { ... },
  "pagination": {
    "has_more": false,
    "next_cursor": null,
    "total_count": 42,
    "limit": 50
  }
}

For single-resource responses (create, update, get by ID), data is an object. For list endpoints, data is an array.

Error responses follow this format:

{
  "success": false,
  "error": "Description of what went wrong"
}

Pagination

List endpoints support cursor-based pagination:

Use the next_cursor value from the response to fetch the next page.

Sorting

Most list endpoints accept a sort parameter in the format field:direction:

GET /api/v1/external/leads?sort=created_at:desc

Common sort fields: created_at, updated_at, name.

Rate Limits

• 100 requests per minute per API key
• Rate limit headers are included in every response:
  • X-RateLimit-Limit — Maximum requests per window
  • X-RateLimit-Remaining — Remaining requests in current window
  • X-RateLimit-Reset — Unix timestamp when the window resets

When rate limited, you receive a 429 Too Many Requests response.

HTTP Status Codes

Available Endpoints