Document Transaction

The document transaction resource.

Basehttps://rest.carbon.ms/documentTransaction

GET/documentTransaction

List document transactions

Retrieve a paginated list of document transactions. 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/documentTransaction

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

Response

[
  {
    "id": "abc123def456",
    "documentId": "xyz789",
    "type": "string",
    "userId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/documentTransaction

Retrieve a document transaction

Fetch a single document transaction by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/documentTransaction

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

Response

{
  "id": "abc123def456",
  "documentId": "xyz789",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/documentTransaction

Create a document transaction

Create a new document transaction.

Body parameters

documentIdstringrequired

References document.id

typedocumentTransactionTyperequired

userIdstringrequired

References user.id

POSThttps://rest.carbon.ms/documentTransaction

curl --request POST \
  --url https://rest.carbon.ms/documentTransaction \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentId":"xyz789","type":"string","userId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "documentId": "xyz789",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/documentTransaction

Update a document transaction

Update an existing document transaction, matched on `id`.

Body parameters

documentIdstringrequired

References document.id

typedocumentTransactionTyperequired

userIdstringrequired

References user.id

PATCHhttps://rest.carbon.ms/documentTransaction

curl --request PATCH \
  --url 'https://rest.carbon.ms/documentTransaction?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"documentId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "documentId": "xyz789",
  "type": "string",
  "userId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/documentTransaction

Delete a document transaction

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/documentTransaction

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

204 No Content