Skip to main content
GET
/
public
/
inboxes
List inboxes
curl --request GET \
  --url https://web-api.clerk.chat/public/inboxes \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Sales Line",
      "phone": "+1415456789"
    }
  ],
  "total": 1,
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  }
}

Authorizations

apiKey
string
header
required

Query Parameters

phone
string

Filter inboxes by phone number

limit
number

Number of items to return (max 50)

page
number

Page number

Response

A paginated list of inboxes

data
object[]
required
total
number
required

The total number of inboxes

Example:

1