External Link
The external link resource.
Basehttps://rest.carbon.ms/externalLink
GET
/externalLinkList external links
Retrieve a paginated list of external links. Filter, order, and select columns with PostgREST query parameters.
Query parameters
selectstringComma-separated columns to return. Defaults to all.
orderstringColumn to sort by, e.g. `createdAt.desc`.
limitintegerMaximum rows to return.
offsetintegerRows 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
/externalLinkRetrieve a external link
Fetch a single external link by filtering on `id`.
Query parameters
idstringMatch 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
/externalLinkCreate a external link
Create a new external link.
Body parameters
documentTypeexternalLinkDocumentTyperequireddocumentIdstringrequiredcustomerIdstringReferences customer.id
expiresAttimestampcompanyIdstringrequiredReferences company.id
supplierIdstringReferences 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
/externalLinkUpdate a external link
Update an existing external link, matched on `id`.
Body parameters
documentTypeexternalLinkDocumentTyperequireddocumentIdstringrequiredcustomerIdstringReferences customer.id
expiresAttimestampcompanyIdstringrequiredReferences company.id
supplierIdstringReferences 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
/externalLinkDelete a external link
Delete a external link, matched on `id`. Returns 204 No Content.
Query parameters
idstringThe `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