Carbon

Industry

The industry resource.

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

List industries

Retrieve a paginated list of industries. 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/industry
curl --request GET \
  --url 'https://rest.carbon.ms/industry?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "sortOrder": 0,
    "active": true,
    "createdAt": "2026-01-01T00:00:00Z",
    "description": "string",
    "iconName": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/industry

Retrieve a industry

Fetch a single industry by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/industry
curl --request GET \
  --url 'https://rest.carbon.ms/industry?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "active": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string",
  "iconName": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/industry

Create a industry

Create a new industry.

Body parameters

namestringrequired
descriptionstring
iconNamestring
sortOrdernumberrequired
activebooleanrequired
POSThttps://rest.carbon.ms/industry
curl --request POST \
  --url https://rest.carbon.ms/industry \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","sortOrder":0,"active":true}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "active": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string",
  "iconName": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/industry

Update a industry

Update an existing industry, matched on `id`.

Body parameters

namestringrequired
descriptionstring
iconNamestring
sortOrdernumberrequired
activebooleanrequired
PATCHhttps://rest.carbon.ms/industry
curl --request PATCH \
  --url 'https://rest.carbon.ms/industry?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",
  "sortOrder": 0,
  "active": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "description": "string",
  "iconName": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/industry

Delete a industry

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

Query parameters

idstring

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

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