List benefits

The benefits the company offers — the catalog, not who is in what. Each carries a count of how many people are enrolled.

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.

hr: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/benefits" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Benefits retrieved successfully!",
  "content": {
    "benefits": [
      {
        "id": "ben_08de",
        "name": "Health insurance",
        "description": "Medical, dental and vision.",
        "createdAt": "2026-01-04T09:00:00.000Z",
        "updatedAt": "2026-01-04T09:00:00.000Z",
        "_count": {
          "employeeBenefits": 12
        }
      }
    ],
    "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 → Benefits

/employee/benefits