Carbon

Material Substance

The material substance resource.

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

List material substances

Retrieve a paginated list of material substances. 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/materialSubstance
curl --request GET \
  --url 'https://rest.carbon.ms/materialSubstance?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "code": "string",
    "companyId": "xyz789",
    "customFields": "string",
    "updatedBy": "string"
  }
]
GET/materialSubstance

Retrieve a material substance

Fetch a single material substance by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/materialSubstance
curl --request GET \
  --url 'https://rest.carbon.ms/materialSubstance?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "code": "string",
  "companyId": "xyz789",
  "customFields": "string",
  "updatedBy": "string"
}
POST/materialSubstance

Create a material substance

Create a new material substance.

Body parameters

namestringrequired
companyIdstring

References company.id

customFieldsobject
tagsarray
codestringrequired
POSThttps://rest.carbon.ms/materialSubstance
curl --request POST \
  --url https://rest.carbon.ms/materialSubstance \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","code":"string"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "code": "string",
  "companyId": "xyz789",
  "customFields": "string",
  "updatedBy": "string"
}
PATCH/materialSubstance

Update a material substance

Update an existing material substance, matched on `id`.

Body parameters

namestringrequired
companyIdstring

References company.id

customFieldsobject
tagsarray
codestringrequired
PATCHhttps://rest.carbon.ms/materialSubstance
curl --request PATCH \
  --url 'https://rest.carbon.ms/materialSubstance?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",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "code": "string",
  "companyId": "xyz789",
  "customFields": "string",
  "updatedBy": "string"
}
DELETE/materialSubstance

Delete a material substance

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

Query parameters

idstring

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

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