Get an agent

One agent with its limit, its auto-scaling setting and its accrued minutes.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

agents:read

Path Parameters

Name	Type	Required	Description
`agentId`	string	Required	Agent ID.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/agents/{agentId}" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Agent retrieved successfully!",
  "content": {
    "agent": {
      "id": "agt_2211",
      "referenceId": 4,
      "type": "CUSTOMER_SUPPORT",
      "name": "Customer Support",
      "hoursLimit": 40,
      "autoScaling": true,
      "minutesAccrued": 812,
      "createdAt": "2026-05-02T09:00:00.000Z",
      "updatedAt": "2026-08-29T09:00:00.000Z"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Agents

/employee/agents