Company

The company resource.

Basehttps://rest.carbon.ms/company

GET/company

List companys

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

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "baseCurrencyCode": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "suggestionNotificationGroup": [],
    "auditLogEnabled": true,
    "isEliminationEntity": true,
    "active": true
  }
]

GET/company

Retrieve a company

Fetch a single company by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/company

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "baseCurrencyCode": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "suggestionNotificationGroup": [],
  "auditLogEnabled": true,
  "isEliminationEntity": true,
  "active": true
}

POST/company

Create a company

Create a new company.

Body parameters

namestringrequired

taxIdstring

addressLine1string

addressLine2string

citystring

stateProvincestring

postalCodestring

countryCodestring

phonestring

faxstring

emailstring

websitestring

baseCurrencyCodestringrequired

References currencyCode.code

logoDarkIconstring

logoLightIconstring

logoDarkstring

logoLightstring

slackChannelstring

suggestionNotificationGrouparrayrequired

auditLogEnabledbooleanrequired

companyGroupIdstring

References companyGroup.id

parentCompanyIdstring

References company.id

isEliminationEntitybooleanrequired

activebooleanrequired

vatNumberstring

eoristring

logoWatermarkstring

POSThttps://rest.carbon.ms/company

curl --request POST \
  --url https://rest.carbon.ms/company \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","baseCurrencyCode":"string","suggestionNotificationGroup":[],"auditLogEnabled":true,"isEliminationEntity":true,"active":true}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "baseCurrencyCode": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "suggestionNotificationGroup": [],
  "auditLogEnabled": true,
  "isEliminationEntity": true,
  "active": true
}

PATCH/company

Update a company

Update an existing company, matched on `id`.

Body parameters

namestringrequired

taxIdstring

addressLine1string

addressLine2string

citystring

stateProvincestring

postalCodestring

countryCodestring

phonestring

faxstring

emailstring

websitestring

baseCurrencyCodestringrequired

References currencyCode.code

logoDarkIconstring

logoLightIconstring

logoDarkstring

logoLightstring

slackChannelstring

suggestionNotificationGrouparrayrequired

auditLogEnabledbooleanrequired

companyGroupIdstring

References companyGroup.id

parentCompanyIdstring

References company.id

isEliminationEntitybooleanrequired

activebooleanrequired

vatNumberstring

eoristring

logoWatermarkstring

PATCHhttps://rest.carbon.ms/company

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "baseCurrencyCode": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "suggestionNotificationGroup": [],
  "auditLogEnabled": true,
  "isEliminationEntity": true,
  "active": true
}

DELETE/company

Delete a company

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/company

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

204 No Content