GET
/api/public/v1/benefits/{benefitId}

Get a benefit

One benefit, with everyone enrolled in it.

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

Path Parameters

NameTypeRequiredDescription
benefitIdstringRequiredBenefit ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/benefits/{benefitId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Benefit retrieved successfully!",
  "content": {
    "benefit": {
      "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"
    }
  }
}

In the console

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

Employees → Benefits
/employee/benefits