Skip to main content
GET
Get substance of concern

Authorizations

X-API-Key
string
header
required

Path Parameters

record_id
string<shortuuid>
required

Id of the substance of concern.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

A regulated substance present in one of the organization's products.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

The organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

The product's GTIN, normalized to GTIN-14.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).

substance_id
string<shortuuid>
required

The substance, from the substance catalog.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
substance_name
string
required

The substance's name.

component_id
string<shortuuid> | null
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
concentration
number | null
required

Measured concentration. Null when unmeasured.

concentration_unit
string
required

Unit of concentration. Empty when unset.

threshold_value
number | null
required

Regulatory or internal limit. Null when unset.

threshold_unit
string
required

Unit of threshold_value. Empty when unset.

regulation
string
required

Regulation the substance is tracked under.

is_above_threshold
boolean
required

Whether the concentration is above the threshold.

notes
string
required

Free-text notes. Empty when unset.