Integrations

The integrations resource.

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

List integrationss

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

Retrieve a integrations

Fetch a single integrations by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/integrations
curl --request GET \
  --url 'https://rest.carbon.ms/integrations?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "jsonschema": "string",
  "metadata": "string",
  "active": true
}