External Link

The external link resource.

Basehttps://rest.carbon.ms/externalLink

GET/externalLink

List external links

Retrieve a paginated list of external links. 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/externalLink

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

Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "documentType": "string",
    "documentId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "companyId": "xyz789",
    "customerId": "xyz789",
    "expiresAt": "2026-01-01T00:00:00Z",
    "supplierId": "xyz789"
  }
]

GET/externalLink

Retrieve a external link

Fetch a single external link by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/externalLink

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "documentType": "string",
  "documentId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "expiresAt": "2026-01-01T00:00:00Z",
  "supplierId": "xyz789"
}

POST/externalLink

Create a external link

Create a new external link.

Body parameters

documentTypeexternalLinkDocumentTyperequired

documentIdstringrequired

customerIdstring

References customer.id

expiresAttimestamp

companyIdstringrequired

References company.id

supplierIdstring

References supplier.id

POSThttps://rest.carbon.ms/externalLink

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "documentType": "string",
  "documentId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "expiresAt": "2026-01-01T00:00:00Z",
  "supplierId": "xyz789"
}

PATCH/externalLink

Update a external link

Update an existing external link, matched on `id`.

Body parameters

documentTypeexternalLinkDocumentTyperequired

documentIdstringrequired

customerIdstring

References customer.id

expiresAttimestamp

companyIdstringrequired

References company.id

supplierIdstring

References supplier.id

PATCHhttps://rest.carbon.ms/externalLink

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "documentType": "string",
  "documentId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "companyId": "xyz789",
  "customerId": "xyz789",
  "expiresAt": "2026-01-01T00:00:00Z",
  "supplierId": "xyz789"
}

DELETE/externalLink

Delete a external link

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/externalLink

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

204 No Content