v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

inbox_types

List inbox types

Lists the workspace's inbox types (id + name). Each id is stable and usable as a message trigger's inboxTypeId (config scopeType inbox) and as the inbox_type_id filter on list conversations. Reserved inbox types return their slug (e.g. guest); custom inbox types return their opaque id.

get/v1/inbox-types

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Response

Every inbox type in the workspace

Example response

{
  "data": [
    {
      "id": "guest",
      "name": "Guest"
    },
    {
      "id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "VIP"
    }
  ]
}