Get a shift

One scheduled shift and who is on 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.

schedule:read

Path Parameters

Name	Type	Required	Description
`shiftId`	string	Required	Shift ID.

GETExample request

curl

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

200Example response

json

{
  "message": "Shift retrieved successfully!",
  "content": {
    "shift": {
      "id": "shf_9911",
      "companyId": "com_001",
      "locationId": "loc_abc123",
      "employeeId": "emp_44f1",
      "startAt": "2026-08-29T13:00:00.000Z",
      "endAt": "2026-08-29T21:00:00.000Z",
      "role": "Front desk",
      "note": null,
      "createdById": "emp_12ab",
      "createdAt": "2026-08-20T10:00:00.000Z",
      "updatedAt": "2026-08-20T10:00:00.000Z"
    }
  }
}

In the console

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

Employees → Scheduling

/employee/scheduling