Carbon

Employee Job

The employee job resource.

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

List employee jobs

Retrieve a paginated list of employee jobs. 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/employeeJob
curl --request GET \
  --url 'https://rest.carbon.ms/employeeJob?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "locationId": "xyz789",
    "shiftId": "xyz789",
    "managerId": "xyz789",
    "title": "string",
    "startDate": "2026-01-01",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/employeeJob

Retrieve a employee job

Fetch a single employee job by filtering on `id`.

Query parameters

idstring

Match on the employee job's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/employeeJob
curl --request GET \
  --url 'https://rest.carbon.ms/employeeJob?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shiftId": "xyz789",
  "managerId": "xyz789",
  "title": "string",
  "startDate": "2026-01-01",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/employeeJob

Create a employee job

Create a new employee job.

Body parameters

locationIdstring

References location.id

shiftIdstring

References shift.id

managerIdstring

References user.id

titlestring
startDatedate
customFieldsobject
departmentIdstring

References department.id

tagsarray
POSThttps://rest.carbon.ms/employeeJob
curl --request POST \
  --url https://rest.carbon.ms/employeeJob \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"id":"abc123def456"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shiftId": "xyz789",
  "managerId": "xyz789",
  "title": "string",
  "startDate": "2026-01-01",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/employeeJob

Update a employee job

Update an existing employee job, matched on `id`.

Body parameters

locationIdstring

References location.id

shiftIdstring

References shift.id

managerIdstring

References user.id

titlestring
startDatedate
customFieldsobject
departmentIdstring

References department.id

tagsarray
PATCHhttps://rest.carbon.ms/employeeJob
curl --request PATCH \
  --url 'https://rest.carbon.ms/employeeJob?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",
  "shiftId": "xyz789",
  "managerId": "xyz789",
  "title": "string",
  "startDate": "2026-01-01",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/employeeJob

Delete a employee job

Delete a employee job, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the employee job to delete, e.g. `eq.{id}`.

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