Industry

The industry resource.

Base/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.

GET/industry

curl --request GET \
  --url '<your-host>/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}`.

GET/industry

curl --request GET \
  --url '<your-host>/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

POST/industry

curl --request POST \
  --url <your-host>/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

PATCH/industry

curl --request PATCH \
  --url '<your-host>/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}`.

DELETE/industry

curl --request DELETE \
  --url '<your-host>/industry?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content