Allo

List inboxes

Returns the caller's inboxes. With user id , returns a teammate's inboxes that have at least one source in a workspace the caller manages, showing only those…

GET/v2/api/inboxes

Behavior

Returns the caller's inboxes. Pass the user_id query parameter to list a teammate's inboxes instead. Only admins and managers of the teammate's workspace can do that. The list then shows only the teammate's inboxes with at least one source in a workspace the caller manages, and only those sources.

filters is always returned with every key. Sources on a line the inbox owner can no longer access are left out of sources.

Errors

StatusCodeWhen
403FORBIDDENuser_id is set and the caller is not an admin or manager of that teammate's workspace

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Query parameters

user_idstring

Act on a teammate's inbox (usr-*). The caller must be an admin or manager of that teammate's workspace, and only reaches inboxes and sources in workspaces they manage. Omit to act on your own inboxes.

Responses

200The inboxes
dataobject[]
7 fields
idstringrequired
namestringrequired
emojistring | nullrequired
sourcesobject[]required
2 fields
allo_numberstringrequired

Allo line (E.164).

conditionsobject[]required

Empty means every conversation on the line.

filtersobjectrequired

Saved filters, with the same meaning as the conversation list filters in the app. "Unread only" is not saved on an inbox: use the unread query parameter of List conversations.

5 fields
typesenum<string>[]

INBOUND_CALLOUTBOUND_CALLTRANSFERREDINBOUND_TEXT_MESSAGEOUTBOUND_TEXT_MESSAGEVOICEMAILAI_ASSISTANT

user_idsstring[]

Teammates (usr-*), up to 50.

contact_idsstring[]

Contacts, up to 50.

contact_list_idsstring[]

Contact lists, up to 10.

tag_keysstring[]

Call tag keys (AI or manual tags, from GET /v2/api/tags), up to 20. A conversation matches when any of its calls on the inbox's lines has one of these tags, not only the last call. Each key must be a tag of your workspace.

notifications_mutedbooleanrequired
favorited_atstring<date-time> | nullrequired

When the owner starred the inbox, null when it is not a favorite. Favorites show first in the app's inbox switcher, oldest star first.

401
403
429