Ndoto REST API Reference — Integration & Automation
Complete reference for the Ndoto REST API. Authenticate with an API token to manage conversations, contacts, agents, inboxes, teams, labels, messages, and webhooks programmatically.
Ndoto REST API Reference
The Ndoto API is a REST API that lets you build integrations, automate workflows, and extend Ndoto with your own systems. All requests and responses use JSON.
Use the API to programmatically manage conversations, contacts, agents, inboxes, teams, messages, labels, and webhooks.
Base URL
https://app.usendoto.com/api/v1Authentication
All API requests must include your API access token in the request header:
api_access_token: YOUR_TOKENYou can find or regenerate your API access token from your profile settings inside Ndoto.
Example
curl https://app.usendoto.com/api/v1/profile \
-H "api_access_token: YOUR_TOKEN"Account ID
Most endpoints are scoped to an account. Replace :account_id in endpoint paths with your numeric account ID, visible in your Ndoto URL when logged in.
Response Format
All responses return JSON. Successful responses return the requested resource. Errors return an object with an error field.
{ "error": "Description of what went wrong" }HTTP Status Codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Resource created |
204 | Success, no content |
400 | Bad request — check your parameters |
401 | Unauthorized — invalid or missing API token |
403 | Forbidden — insufficient permissions |
404 | Not found |
422 | Validation error |
429 | Rate limit exceeded |
500 | Server error |
Pagination
List endpoints return paginated results. Use the page query parameter to navigate pages.
GET /api/v1/accounts/:account_id/conversations?page=2Paginated responses include a meta object:
{
"data": [...],
"meta": {
"count": 25,
"current_page": 2,
"total_pages": 8
}
}API Endpoints
Conversations
Create, list, and manage conversations.
Messages
Send and retrieve messages within conversations.
Contacts
Manage your contact records.
Inboxes
List and configure your inboxes.
Teams
Manage teams and team members.
Agents
Manage agents in your account.
Labels
Create and manage conversation labels.
Webhooks
Subscribe to real-time events.
Frequently Asked Questions
How do I authenticate with the Ndoto API?
Include your API access token in every request as a header: api_access_token: YOUR_TOKEN. You can find your token in your Ndoto profile settings.
Where do I find my Account ID?
Your account ID is visible in the URL when you are logged into Ndoto (e.g., app.usendoto.com/app/accounts/123/... — 123 is your account ID).
Does the API support webhooks? Yes. Ndoto webhooks let you subscribe to real-time events — such as new messages or conversation status changes — and receive HTTP POST notifications to your endpoint.
Related Docs
Ndoto Documentation — Omnichannel Customer Support Platform
Learn how Ndoto brings email, WhatsApp, live chat, Instagram, and 10+ channels into one shared inbox. Explore AI automation with Akili, conversation management, reports, and REST API integration.
Agents
Manage agents in your account via the API