Carbon

Approval Rule

The approval rule resource.

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

List approval rules

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

Retrieve a approval rule

Fetch a single approval rule by filtering on `id`.

Query parameters

idstring

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

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

Create a approval rule

Create a new approval rule.

Body parameters

documentTypeapprovalDocumentTyperequired
enabledbooleanrequired
approverGroupIdsarray
defaultApproverIdstring

References user.id

lowerBoundAmountnumberrequired
escalationDaysnumber
POSThttps://rest.carbon.ms/approvalRule
curl --request POST \
  --url https://rest.carbon.ms/approvalRule \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentType":"string","enabled":true,"lowerBoundAmount":0}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "enabled": true,
  "lowerBoundAmount": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "approverGroupIds": []
}
PATCH/approvalRule

Update a approval rule

Update an existing approval rule, matched on `id`.

Body parameters

documentTypeapprovalDocumentTyperequired
enabledbooleanrequired
approverGroupIdsarray
defaultApproverIdstring

References user.id

lowerBoundAmountnumberrequired
escalationDaysnumber
PATCHhttps://rest.carbon.ms/approvalRule
curl --request PATCH \
  --url 'https://rest.carbon.ms/approvalRule?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentType":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "enabled": true,
  "lowerBoundAmount": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "approverGroupIds": []
}
DELETE/approvalRule

Delete a approval rule

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

Query parameters

idstring

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

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