Carbon

Configuration Parameter

The configuration parameter resource.

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

List configuration parameters

Retrieve a paginated list of configuration parameters. 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/configurationParameter
curl --request GET \
  --url 'https://rest.carbon.ms/configurationParameter?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "itemId": "xyz789",
    "label": "string",
    "key": "string",
    "dataType": "string",
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/configurationParameter

Retrieve a configuration parameter

Fetch a single configuration parameter by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/configurationParameter
curl --request GET \
  --url 'https://rest.carbon.ms/configurationParameter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "key": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/configurationParameter

Create a configuration parameter

Create a new configuration parameter.

Body parameters

itemIdstringrequired

References item.id

labelstringrequired
keystringrequired
dataTypeconfigurationParameterDataTyperequired
listOptionsarray
configurationParameterGroupIdstring

References configurationParameterGroup.id

sortOrdernumberrequired
companyIdstringrequired

References company.id

materialFormFilterIdstring

References materialForm.id

POSThttps://rest.carbon.ms/configurationParameter
curl --request POST \
  --url https://rest.carbon.ms/configurationParameter \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","label":"string","key":"string","dataType":"string","sortOrder":0,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "key": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/configurationParameter

Update a configuration parameter

Update an existing configuration parameter, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

labelstringrequired
keystringrequired
dataTypeconfigurationParameterDataTyperequired
listOptionsarray
configurationParameterGroupIdstring

References configurationParameterGroup.id

sortOrdernumberrequired
companyIdstringrequired

References company.id

materialFormFilterIdstring

References materialForm.id

PATCHhttps://rest.carbon.ms/configurationParameter
curl --request PATCH \
  --url 'https://rest.carbon.ms/configurationParameter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "itemId": "xyz789",
  "label": "string",
  "key": "string",
  "dataType": "string",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/configurationParameter

Delete a configuration parameter

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

Query parameters

idstring

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

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