Company Integration

The company integration resource.

Basehttps://rest.carbon.ms/companyIntegration

GET/companyIntegration

List company integrations

Retrieve a paginated list of company integrations. 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/companyIntegration

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "metadata": "string",
    "active": true,
    "updatedAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string"
  }
]

GET/companyIntegration

Retrieve a company integration

Fetch a single company integration by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/companyIntegration

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "metadata": "string",
  "active": true,
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

POST/companyIntegration

Create a company integration

Create a new company integration.

Body parameters

metadataobjectrequired

activebooleanrequired

POSThttps://rest.carbon.ms/companyIntegration

curl --request POST \
  --url https://rest.carbon.ms/companyIntegration \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"metadata":"string","active":true}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "metadata": "string",
  "active": true,
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

PATCH/companyIntegration

Update a company integration

Update an existing company integration, matched on `id`.

Body parameters

metadataobjectrequired

activebooleanrequired

PATCHhttps://rest.carbon.ms/companyIntegration

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "metadata": "string",
  "active": true,
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}

DELETE/companyIntegration

Delete a company integration

Delete a company integration, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the company integration to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/companyIntegration

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

204 No Content