Agent by ID - Chat API

GET

agents

{id}

Show agent by ID.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "display_id": 4915223567929,
    "name": "John Doe",
    "in_sync": true,
    "unread_conversations_count": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Response

200 - application/json

Success

data

object

Represents an agent belonging to a messenger service. A business phone number registered on WhatsApp is an agent.

Show child attributes

List of available customersList available customers.

Show agent by ID.

curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": 123,
    "display_id": 4915223567929,
    "name": "John Doe",
    "in_sync": true,
    "unread_conversations_count": 123
  }
}