GET
/api/public/v1/employees/{employeeId}/benefitsList an employee’s benefits
Which benefits one person is enrolled in.
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
| Name | Type | Required | Description |
|---|---|---|---|
employeeId | string | Required | Employee ID. |
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/employees/{employeeId}/benefits" \
-H "Authorization: Bearer your_access_token"200Example response
json
{
"message": "Employee 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"
}
]
}
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.