Skip to main content
GET
/
organisations
List organisations
curl --request GET \
  --url https://api.demo.cula.earth/tracking/v1/organisations \
  --header 'Authorization: Bearer <token>' \
  --header 'Cula-Organisation-Id: <cula-organisation-id>'
{
  "data": [
    {
      "id": "org_01kqzcjrpyf27tge87es6ns4w3",
      "external_id": null,
      "name": "GreenCarbon Inc.",
      "address": {
        "street": "100 Industrial Parkway",
        "city": "Richardton",
        "postcode": "58652",
        "country": "United States",
        "country_code": "US"
      },
      "managed_by_site": null
    }
  ],
  "pagination": {
    "starting_after": null,
    "limit": 10,
    "has_more": false,
    "next_cursor": null
  }
}

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.

Query Parameters

starting_after
string

Cursor for forward pagination. Pass the next_cursor value from a previous response to fetch the next page. Must be a valid resource ID.

limit
integer
default:10

Maximum number of items to return per page.

Required range: 1 <= x <= 50

Response

Paginated list of organisations.

data
object[]
required
pagination
object
required

Cursor-based pagination metadata.