Approval Request

The approval request resource.

Basehttps://rest.carbon.ms/approvalRequest

GET/approvalRequest

List approval requests

Retrieve a paginated list of approval requests. 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/approvalRequest

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "documentType": "string",
    "documentId": "xyz789",
    "status": "string",
    "requestedBy": "string",
    "requestedAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/approvalRequest

Retrieve a approval request

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/approvalRequest

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "documentId": "xyz789",
  "status": "string",
  "requestedBy": "string",
  "requestedAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/approvalRequest

Create a approval request

Create a new approval request.

Body parameters

documentTypeapprovalDocumentTyperequired

documentIdstringrequired

statusapprovalStatusrequired

amountnumber

requestedBystringrequired

References user.id

requestedAttimestamprequired

decisionBystring

References user.id

decisionAttimestamp

decisionNotesstring

POSThttps://rest.carbon.ms/approvalRequest

curl --request POST \
  --url https://rest.carbon.ms/approvalRequest \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentType":"string","documentId":"xyz789","status":"string","requestedBy":"string","requestedAt":"2026-01-01T00:00:00Z"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "documentType": "string",
  "documentId": "xyz789",
  "status": "string",
  "requestedBy": "string",
  "requestedAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/approvalRequest

Update a approval request

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

Body parameters

documentTypeapprovalDocumentTyperequired

documentIdstringrequired

statusapprovalStatusrequired

amountnumber

requestedBystringrequired

References user.id

requestedAttimestamprequired

decisionBystring

References user.id

decisionAttimestamp

decisionNotesstring

PATCHhttps://rest.carbon.ms/approvalRequest

curl --request PATCH \
  --url 'https://rest.carbon.ms/approvalRequest?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",
  "documentId": "xyz789",
  "status": "string",
  "requestedBy": "string",
  "requestedAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/approvalRequest

Delete a approval request

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/approvalRequest

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

204 No Content