Contractors

The contractors resource.

Basehttps://rest.carbon.ms/contractors

GET/contractors

List contractorss

Retrieve a paginated list of contractorss. 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/contractors

curl --request GET \
  --url 'https://rest.carbon.ms/contractors?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "supplierContactId": "xyz789",
    "supplierId": "xyz789",
    "active": true,
    "hoursPerWeek": 0,
    "companyId": "xyz789",
    "customFields": "string",
    "supplierName": "string",
    "fullName": "string"
  }
]

GET/contractors

Retrieve a contractors

Fetch a single contractors by filtering on `supplierContactId`.

Query parameters

supplierContactIdstring

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

GEThttps://rest.carbon.ms/contractors

curl --request GET \
  --url 'https://rest.carbon.ms/contractors?supplierContactId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "supplierContactId": "xyz789",
  "supplierId": "xyz789",
  "active": true,
  "hoursPerWeek": 0,
  "companyId": "xyz789",
  "customFields": "string",
  "supplierName": "string",
  "fullName": "string"
}