Carbon

Document

The document resource.

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

List documents

Retrieve a paginated list of documents. 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/document
curl --request GET \
  --url 'https://rest.carbon.ms/document?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "path": "string",
    "name": "Example",
    "size": 0,
    "type": "string",
    "active": true,
    "companyId": "xyz789",
    "createdBy": "string"
  }
]
GET/document

Retrieve a document

Fetch a single document by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/document
curl --request GET \
  --url 'https://rest.carbon.ms/document?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "path": "string",
  "name": "Example",
  "size": 0,
  "type": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}
POST/document

Create a document

Create a new document.

Body parameters

pathstringrequired
namestringrequired
descriptionstring
sizenumberrequired
extensionstring
typedocumentTyperequired
readGroupsarray
writeGroupsarray
activebooleanrequired
companyIdstringrequired
sourceDocumentdocumentSourceType
sourceDocumentIdstring
POSThttps://rest.carbon.ms/document
curl --request POST \
  --url https://rest.carbon.ms/document \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"path":"string","name":"Example","description":"string","size":0,"type":"string","active":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "path": "string",
  "name": "Example",
  "size": 0,
  "type": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}
PATCH/document

Update a document

Update an existing document, matched on `id`.

Body parameters

pathstringrequired
namestringrequired
descriptionstring
sizenumberrequired
extensionstring
typedocumentTyperequired
readGroupsarray
writeGroupsarray
activebooleanrequired
companyIdstringrequired
sourceDocumentdocumentSourceType
sourceDocumentIdstring
PATCHhttps://rest.carbon.ms/document
curl --request PATCH \
  --url 'https://rest.carbon.ms/document?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"path":"string"}'
Response
{
  "id": "abc123def456",
  "path": "string",
  "name": "Example",
  "size": 0,
  "type": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string"
}
DELETE/document

Delete a document

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

Query parameters

idstring

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

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