Document Section

The document section resource.

Basehttps://rest.carbon.ms/documentSection

GET/documentSection

List document sections

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

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "name": "Example",
    "placement": "string",
    "content": "string",
    "config": "string",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/documentSection

Retrieve a document section

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/documentSection

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "placement": "string",
  "content": "string",
  "config": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/documentSection

Create a document section

Create a new document section.

Body parameters

namestringrequired

placementstringrequired

contentobjectrequired

configobjectrequired

POSThttps://rest.carbon.ms/documentSection

curl --request POST \
  --url https://rest.carbon.ms/documentSection \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","placement":"string","content":"string","config":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "placement": "string",
  "content": "string",
  "config": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/documentSection

Update a document section

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

Body parameters

namestringrequired

placementstringrequired

contentobjectrequired

configobjectrequired

PATCHhttps://rest.carbon.ms/documentSection

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "name": "Example",
  "placement": "string",
  "content": "string",
  "config": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/documentSection

Delete a document section

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/documentSection

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

204 No Content