Carbon

Contractor

The contractor resource.

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

List contractors

Retrieve a paginated list of contractors. 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/contractor
curl --request GET \
  --url 'https://rest.carbon.ms/contractor?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "hoursPerWeek": 0,
    "active": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/contractor

Retrieve a contractor

Fetch a single contractor by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/contractor
curl --request GET \
  --url 'https://rest.carbon.ms/contractor?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "hoursPerWeek": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/contractor

Create a contractor

Create a new contractor.

Body parameters

hoursPerWeeknumberrequired
activebooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/contractor
curl --request POST \
  --url https://rest.carbon.ms/contractor \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"hoursPerWeek":0,"active":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "hoursPerWeek": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/contractor

Update a contractor

Update an existing contractor, matched on `id`.

Body parameters

hoursPerWeeknumberrequired
activebooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/contractor
curl --request PATCH \
  --url 'https://rest.carbon.ms/contractor?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"hoursPerWeek":0}'
Response
{
  "id": "abc123def456",
  "hoursPerWeek": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/contractor

Delete a contractor

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

Query parameters

idstring

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

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