Desk API#
Novaza Desk exposes a REST API for contacts, conversations, messages, and tickets. The API is served by the Desk product directly at https://desk.novaza.ai and is not proxied through the Novaza Platform Gateway.
Access and Authentication#
Because the Desk API is served by the product directly, it has its own authentication handshake that is separate from the Platform Gateway at api.novaza.ai. Clients must obtain a Desk access token before calling Desk API endpoints.
- Base URL:
https://desk.novaza.ai - Authentication: OAuth2 Authorization Code flow against Novaza SSO (
id.novaza.ai) - Token header:
Authorization: Bearer <access_token> - Requires separate auth: a JWT issued for
api.novaza.aicannot be reused here; exchange via Novaza SSO for a Desk-scoped token.
See API Authentication for the OAuth2 flow and token exchange details.
What You Can Do#
The Desk API supports the same actions that are available in the Desk user interface, including:
- Managing contacts and their custom attributes
- Listing, creating, and updating conversations across all channels
- Posting replies and internal notes
- Managing tickets, labels, assignments, and priorities
- Reading channel and team configuration
API Reference#
For the complete endpoint list, request/response schemas, and parameter documentation, see the Desk product’s own API reference available from within the Desk application:
Desk → Settings → Integrations → API
The in-product reference is always in sync with the version of Desk deployed to your workspace and includes an interactive request console.
Related#
- API Authentication — how to obtain an access token from Novaza SSO
- Platform Gateway API — platform-level endpoints served at
api.novaza.ai - Webhooks — platform webhook overview (outbound event forwarding)