Skip to main content
GET
Get a sink

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:

"snk_01kpb4n7arexs9cjf0ffmdtjry"

Response

Sink with tracking steps

id
string
required
Example:

"snk_01kpb4n7arexs9cjf0ffmdtjry"

owner_organisation_id
string
required
Example:

"org_01k83mfmhgchya944v86ryvhpq"

public_url
string<uri>
required

Public URL to view the sink on the Cula Carbon Hub.

Example:

"https://hub.cula.earth/globe/sink?id=snk_01kpb4n7arexs9cjf0ffmdtjry"

tracked_gross_co2e_removal_in_kg
number
required
Required range: x >= 0
Example:

6000.5

tracked_net_co2e_removal_in_kg
number
required
Required range: x >= 0
Example:

5874.3

verified_net_co2e_removal_in_kg
number | null
required
Required range: x >= 0
Example:

5874.3

registry_reference
object | null
required
confirmation_document_id
string | null
required
Example:

"doc_01kw9grq4tecva35wdpstzcj5z"

verified_at
string<date-time> | null
required

The day the removal was verified by the registry. Day-granular, so the time component is always midnight UTC.

Example:

"2025-10-10T00:00:00Z"

created_at
string<date-time>
required
Example:

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

material_application_tracking_step_id
string
required
Example:

"stp_01kvv8692rjmch08b3e7hgdx3h"

tracking_steps
(Delivery · object | Material Creation · object | Material Processing · object | Material Application · object)[]
required