Docs / NabatDesk Core API
NabatDesk Core API
Contacts, messages, inbox, tags, segments, automations, channels, webhooks, and usage — authenticated with a NabatDesk API key.
Paid plan required for Developer API capabilities. Use
Authorization: Bearer YOUR_NABATDESK_API_KEY.Authentication
Authorization: Bearer YOUR_NABATDESK_API_KEY Base URL: /api/v1
Organization is resolved from the API key. Never send Telegram tokens or provider secrets.
Contacts
Scopes: contacts:read, contacts:write
- GET /contacts
- GET /contacts/:id
- POST /contacts
- PATCH /contacts/:id
- DELETE /contacts/:id
- POST /contacts/:id/tags/:tagId
- DELETE /contacts/:id/tags/:tagId
Messages
NabatDesk is contact-centric (no Conversation table). Scopes: contacts:read|write or messages:read|write
- GET /contacts/:id/messages
- POST /contacts/:id/messages
- POST /contacts/:id/messages/media
- PATCH /contacts/:id/messages/:messageId
- DELETE /contacts/:id/messages/:messageId
Inbox
Scope: inbox:read (aliases contacts read). Envelope: { success, data, meta }
- GET /inbox
Tags & segments
- GET/POST/PATCH/DELETE /tags
- GET/POST/PATCH/DELETE /segments
- GET /segments/:id/contacts
Automations
- GET /automations
- GET /automations/:id
- POST /automations
- PATCH /automations/:id
- DELETE /automations/:id
- POST /automations/:id/activate
- POST /automations/:id/pause
Channels & usage
- GET /channels
- GET /connections/status
- GET /usage
- GET /usage/daily
- GET /usage/endpoints
Webhooks
Outbound customer webhooks (HMAC signed). Scopes: webhooks:read, webhooks:write
- GET/POST /webhooks/outbound
- GET/PUT/DELETE /webhooks/outbound/:id
- POST /webhooks/outbound/:id/test
- GET /webhooks/outbound/:id/deliveries
- POST /webhooks/outbound/:id/deliveries/:deliveryId/retry
Example
curl -sS "/api/v1/contacts?limit=20" \ -H "Authorization: Bearer YOUR_NABATDESK_API_KEY"