Skip to main content
GET
/
organisations
/
{id}
Get an organisation
curl --request GET \
  --url https://api.demo.cula.earth/tracking/v1/organisations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cula-Organisation-Id: <cula-organisation-id>'
{
  "id": "org_01kqzcjrpyf27tge87es6ns4w3",
  "name": "GreenCarbon Inc.",
  "external_id": "<string>",
  "address": {
    "city": "Berlin",
    "country": "Germany",
    "country_code": "DE",
    "street": "Friedrichstrasse 1",
    "postcode": "10117"
  },
  "managed_by_site": {
    "id": "<string>",
    "external_id": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Exchange your client_id and client_secret for a short-lived access token, then pass it as a Bearer token in the Authorization header.

Headers

​
Cula-Organisation-Id
string
required

Organisation ID that scopes this request. The authenticated consumer must be authorized for this organisation. Omitting this header returns 400; passing an unauthorised org returns 403.

Path Parameters

​
id
string
required

Cula-assigned resource ID in TypeID format (e.g. stp_01kqzcjrpxf27tge33jwvjhkff). Alternatively, pass your external ID prefixed with ext- (e.g. ext-MY-STEP-001). The ext- prefix is unambiguous because TypeIDs use _ separators and never start with ext-.

Response

Organisation details.

​
id
string
required
Example:

"org_01kqzcjrpyf27tge87es6ns4w3"

​
name
string
required
Example:

"GreenCarbon Inc."

​
external_id
string | null
​
address
object

Postal address of the organisation, if known.

​
managed_by_site
object

The site that manages this organisation record. Null for organisations not created via the API.