Document Labels

The document labels resource.

Basehttps://rest.carbon.ms/documentLabels

GET/documentLabels

List document labelss

Retrieve a paginated list of document labelss. Filter, order, and select columns with PostgREST 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/documentLabels

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

Response

[
  {
    "label": "string",
    "userId": "xyz789"
  }
]

GET/documentLabels

Fetch a single document labels by filtering on `label`.

labelstring

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

GEThttps://rest.carbon.ms/documentLabels

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

Response

{
  "label": "string",
  "userId": "xyz789"
}