Skip to main content
GET
Get a material batch config

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:

"mbtc_01kdpna98wj3apgan3j36w499h"

Response

id
string
required

The ID of the batch config.

Example:

"mbtc_01kdpna98wj3apgan3j36w499h"

site
object
required

The site that owns this config.

validity_period_type
enum<string>
required

How batches of this config track validity periods: day_based boundaries are calendar dates (2026-05-01), time_based boundaries are UTC timestamps truncated to the minute (2026-05-01T12:30:00Z), none batches carry no validity period.

Available options:
day_based,
time_based,
none
Example:

"day_based"

created_at
string<date-time>
required

When this config was created.

Example:

"2026-01-15T08:00:00Z"

active_version
object
required

The currently active version of the batch config, including its full data point configuration.