Skip to main content
GET
Get a material pool

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Path Parameters

id
string
required
Example:

"mpl_01k2xytkbr0pxazkxbj4j5gr0y"

Response

Material pool with its current per-material balances.

id
string
required

Unique identifier of the material pool.

Example:

"mpl_01k2xytkbr0pxazkxbj4j5gr0y"

external_id
string | null
required

The external ID you assigned to this pool, if any.

Example:

"POOL-EXT-0001"

name
string | null
required

User-given name of the pool, if any.

Example:

"Woodchips pile north"

type
enum<string>
required

Physical form of the pool: a solid pile or a liquid tank.

Available options:
pile,
tank
Example:

"pile"

transaction_strategy
enum<string>
required

How mixed material is attributed to its sources during carbon accounting: queue consumes contributions oldest-first (FIFO), stack newest-first (LIFO). Fixed at creation.

Available options:
queue,
stack
Example:

"stack"

is_archived
boolean
required

Archived pools are excluded from inventory views and are never auto-selected as a transaction target.

Example:

false

site
object
required

The site owning this pool.

contents
object[]
required

Current per-material balances.

created_at
string<date-time>
required

Time the pool was created.

Example:

"2025-10-10T21:03:58Z"