Skip to main content
GET
Get consumable

Authorizations

X-API-Key
string
header
required

Path Parameters

consumable_id
string<shortuuid>
required

Id of the consumable.

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

Response

OK

A consumable of 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}$
product
ConsumableProductOut · object
required

The product the consumable is used with.

Example:
consumable
ConsumableProductOut · object
required

The product that serves as the consumable.

Example:
estimated_lifespan
string
required

How long one unit lasts, as free text. Empty when unset.

is_required
boolean
required

Whether the product needs this consumable to work.

note
string
required

Short note shown with the consumable. Empty when unset.

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).