List agents

The AI agents the company has hired. One per role at most — the pair of company and type is unique — so this list is short and each entry is a desk rather than a headcount. `minutesAccrued` is what the agent has actually worked this cycle, which is what it bills against.

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

Query Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.

GETExample request

curl

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

200Example response

json

{
  "message": "Agents retrieved successfully!",
  "content": {
    "agents": [
      {
        "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"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

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

Employees → Agents

/employee/agents