Organisations

API endpoints for organisations

List organisations

GET /api/v1/organisations

curl -X GET \
"https://api.example.com/api/v1/organisations" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Status: 200

{
  "data": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Other statuses: 401.

{ data: Organisation[] }

GET /api/v1/organisations/{id}

Name	In	Type	Required	Description
`id`	path	string	Yes	Path parameter.

curl -X GET \
"https://api.example.com/api/v1/organisations/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Status: 200

{
  "data": {
    "id": "string",
    "name": "string"
  }
}

Other statuses: 401, 404.

{ data: Organisation }