Carbon

People Assignment

The people assignment resource.

Basehttps://rest.carbon.ms/peopleAssignment
GET/peopleAssignment

List people assignments

Retrieve a paginated list of people assignments. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/peopleAssignment
curl --request GET \
  --url 'https://rest.carbon.ms/peopleAssignment?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "locationId": "xyz789",
    "workCenterId": "xyz789",
    "employeeId": "xyz789",
    "date": "2026-01-01",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/peopleAssignment

Retrieve a people assignment

Fetch a single people assignment by filtering on `id`.

Query parameters

idstring

Match on the people assignment's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/peopleAssignment
curl --request GET \
  --url 'https://rest.carbon.ms/peopleAssignment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "workCenterId": "xyz789",
  "employeeId": "xyz789",
  "date": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/peopleAssignment

Create a people assignment

Create a new people assignment.

Body parameters

locationIdstringrequired

References location.id

workCenterIdstringrequired

References workCenter.id

employeeIdstringrequired

References user.id

datedaterequired
shiftIdstring

References shift.id

notestring
overtimeHoursnumberrequired
hoursnumber
POSThttps://rest.carbon.ms/peopleAssignment
curl --request POST \
  --url https://rest.carbon.ms/peopleAssignment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"locationId":"xyz789","workCenterId":"xyz789","employeeId":"xyz789","date":"2026-01-01","overtimeHours":0}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "workCenterId": "xyz789",
  "employeeId": "xyz789",
  "date": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/peopleAssignment

Update a people assignment

Update an existing people assignment, matched on `id`.

Body parameters

locationIdstringrequired

References location.id

workCenterIdstringrequired

References workCenter.id

employeeIdstringrequired

References user.id

datedaterequired
shiftIdstring

References shift.id

notestring
overtimeHoursnumberrequired
hoursnumber
PATCHhttps://rest.carbon.ms/peopleAssignment
curl --request PATCH \
  --url 'https://rest.carbon.ms/peopleAssignment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"locationId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "workCenterId": "xyz789",
  "employeeId": "xyz789",
  "date": "2026-01-01",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/peopleAssignment

Delete a people assignment

Delete a people assignment, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the people assignment to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/peopleAssignment
curl --request DELETE \
  --url 'https://rest.carbon.ms/peopleAssignment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content