Docs
ChangelogالعربيةDashboard
DocumentationAPI reference
API referenceList WhatsApp inboxes
  • Introduction
  • Authentication
    • GETVerify API key
  • Agents
    • POSTCreate agent
    • GETList agents
    • GETGet agent
    • PUTUpdate agent
    • DELDelete agent
    • POSTLink analysis groups to an agent
    • GETList analysis groups for an agent
  • Tools
    • POSTCreate tool
    • GETList tools
    • GETGet tool
    • PUTUpdate tool
    • DELDelete tool
    • POSTLink a tool to an agent
    • DELUnlink a tool from an agent
    • GETList tools for an agent
    • GETList agents for a tool
  • Analysis groups
    • POSTCreate analysis group
    • GETList analysis groups
    • GETGet analysis group
    • PUTUpdate analysis group
    • DELDelete analysis group
    • POSTLink an agent to an analysis group
    • POSTLink agents to an analysis group
    • GETList agents for an analysis group
    • DELUnlink an analysis group from an agent
  • Knowledge bases
    • POSTCreate knowledge base
    • GETList knowledge bases
    • GETGet knowledge base
    • PATCHUpdate knowledge base
    • DELDelete knowledge base
  • Documents
    • POSTAdd PDF document
    • POSTAdd text document
    • POSTAdd URL document
    • GETList documents
    • GETGet document
    • DELDelete document
  • Calls
    • POSTCreate outbound call
    • GETGet call
    • POSTSearch calls
    • POSTGet call analytics
    • POSTExport calls
    • GETGet recording download URL
    • POSTCreate outbound call (legacy path)
  • Web calls
    • POSTCreate web call
    • POSTCreate web call (legacy path)
  • SIP inbound
    • POSTCreate SIP inbound trunk
    • GETList SIP inbound trunks
    • GETGet SIP inbound trunk
    • DELDelete SIP inbound trunk
  • SIP outbound
    • POSTCreate SIP outbound trunk
    • GETList SIP outbound trunks
    • GETGet SIP outbound trunk
    • DELDelete SIP outbound trunk
  • Agent inbound links
    • POSTLink an agent to an inbound trunk
    • GETList agent inbound links
    • DELDelete agent inbound link
  • Text to speech
    • POSTGenerate speech
    • GETList voices
    • GETGet voice
    • POSTClone a voice
    • DELDelete cloned voice
  • Speech to text
    • POSTTranscribe an audio file
    • GETGet transcription job
    • GETList transcription jobs
    • WSStream speech to text
  • Contacts
    • POSTCreate contact
    • GETList contacts
    • GETSearch contacts
    • GETGet contact
    • PATCHUpdate contact
    • GETList conversations for a contact
  • Conversations
    • GETList conversations
    • POSTFilter conversations
    • POSTList conversations by contact
    • GETGet conversation
    • GETList conversation messages
    • POSTSend a message
    • POSTSend a message with an attachment
    • GETList conversation attachments
    • POSTAssign conversation
    • POSTChange conversation status
    • POSTChange conversation priority
    • POSTMark conversation as seen
  • Tickets
    • POSTCreate ticket
    • GETList tickets
    • POSTFilter tickets
    • POSTList tickets by contact
    • GETGet ticket
    • GETList ticket messages
    • POSTAdd a ticket message
    • POSTAdd a ticket message with attachments
    • POSTAssign ticket
    • POSTChange ticket status
    • POSTChange ticket priority
    • POSTChange ticket type
    • POSTCreate ticket inbox
    • GETList ticket inboxes
    • PATCHUpdate ticket inbox
    • DELDelete ticket inbox
  • WhatsApp
    • POSTConnect a WhatsApp number
    • GETList WhatsApp inboxes
    • GETGet WhatsApp inbox
    • PATCHUpdate WhatsApp inbox
    • DELDelete WhatsApp inbox
    • POSTCreate WhatsApp conversation
    • GETList WhatsApp conversations
    • POSTFilter WhatsApp conversations
    • POSTList WhatsApp conversations by contact
    • POSTAssign an agent to a WhatsApp number
    • GETGet the agent on a WhatsApp number
    • DELRemove the agent from a WhatsApp number
    • POSTGet WhatsApp analytics
  • Instagram
    • GETList Instagram accounts
    • GETGet Instagram account
    • DELDelete Instagram account
    • GETList Instagram conversations
    • POSTFilter Instagram conversations
    • POSTList Instagram conversations by contact
    • POSTAssign an agent to an Instagram account
    • GETGet the agent on an Instagram account
    • DELRemove the agent from an Instagram account
  • TikTok
    • GETList TikTok accounts
    • GETGet TikTok account
    • DELDelete TikTok account
    • GETList TikTok conversations
    • POSTFilter TikTok conversations
    • POSTList TikTok conversations by contact
    • POSTAssign an agent to a TikTok account
    • GETGet the agent on a TikTok account
    • DELRemove the agent from a TikTok account

WhatsApp

List WhatsApp inboxes

List the WhatsApp inboxes connected to the project, oldest first. Each inbox represents a connected WhatsApp number and includes its id, inbox_type, project_id, display name, config, created_at, and the agent answering on it. Use the returned id as the inbox_id for the other WhatsApp endpoints.

GET
https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes
List WhatsApp inboxes
curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/whatsapp/inboxes' \
  --header 'X-API-Key: <your-api-key>'
{
  "inboxes": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "inbox_type": "whatsapp",
      "project_id": "00000000-0000-4000-8000-000000000000",
      "name": "string",
      "config": {},
      "created_at": "2026-01-15T12:00:00.000Z",
      "inbox_id": 0,
      "chatbot_agent_id": "00000000-0000-4000-8000-000000000000",
      "chatbot_agent_name": "string"
    }
  ],
  "max_inboxes": 0
}

Where inbox IDs come from

This is the canonical source for inbox_id values used by other WhatsApp endpoints.

inboxes[].id

The UUID of each WhatsApp inbox. Pass it as inbox_id to the other WhatsApp endpoints, or as the {inbox_id} path parameter to GET full inbox details.

idinbox_typeproject_idnameconfigcreated_at
inboxes[].inbox_id

A numeric id for the number. Conversations carry the same value in their inbox_id field, so you can tell which number a conversation came in on. Do not pass it as inbox_id to other endpoints.

inbox_id
Answering agent

The agent auto-replying on the number, or null when none is assigned.

chatbot_agent_idchatbot_agent_name
max_inboxes

How many WhatsApp numbers the project may connect. Contact support to raise it.

max_inboxes
How the number was connected

config.connection_method is embedded_signup for numbers connected through Meta sign-in in the app, and is absent for numbers connected with their credentials. Numbers connected through Meta sign-in also include config.verified_name and config.name_status (the display name and its review status). config.meta_disconnected is true when access to the number was removed in Meta; reconnect it from the app to keep its conversations and settings.

config.connection_methodconfig.verified_nameconfig.name_statusconfig.meta_disconnected

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Response

200

Successful Response

application/json

PreviousConnect a WhatsApp numberNextGet WhatsApp inbox
© 2026 Nabrah. All rights reserved.
ChangelogPrivacy PolicyTerms of Service