Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
inbox_members
/
{inbox_id}
List Agents in Inbox
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/inbox_members/{inbox_id} \
  --header 'api_access_token: <api-key>'
{
  "payload": [
    {
      "id": 123,
      "account_id": 123,
      "availability_status": "available",
      "auto_offline": true,
      "confirmed": true,
      "email": "<string>",
      "available_name": "<string>",
      "name": "<string>",
      "role": "agent",
      "thumbnail": "<string>",
      "custom_role_id": 123
    }
  ]
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
inbox_id
integer
required

The ID of the Inbox

​
account_id
integer
required

The numeric ID of the account

Response

Success

​
payload
object[]

Array of all active agents