Carbon

Service

The service resource.

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

List services

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

Retrieve a service

Fetch a single service by filtering on `id`.

Query parameters

idstring

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

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

Create a service

Create a new service.

Body parameters

itemIdstring

References item.id

serviceTypeserviceTyperequired
approvedbooleanrequired
approvedBystring

References user.id

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

Update a service

Update an existing service, matched on `id`.

Body parameters

itemIdstring

References item.id

serviceTypeserviceTyperequired
approvedbooleanrequired
approvedBystring

References user.id

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

Delete a service

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

Query parameters

idstring

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

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