Get Organisation¶

Returns a single organisation.

Endpoint¶

GET /v2/organisations/{organisation_id}

Path Parameters¶

Parameter	Type	Required	Description
`organisation_id`	string	Yes	The organisation this record belongs to. Derived from the access token on writes and never trusted from the body.

Request¶

curl --location '{base_url}/v2/organisations/7412' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "id": "7412",
  "name": "Example Therapy Group",
  "website": "https://www.example.com",
  "logo_url": "https://assets.example.com/logo.png",
  "domain_name": "example-therapy",
  "send_domain_url": true,
  "active": true,
  "go_live_date": "2026-02-16",
  "created_at": "2026-08-27T14:30:00Z",
  "updated_at": "2026-08-27T14:30:00Z"
}

Response Fields¶

Field	Type	Description
`id`	string	The organisation id.
`name`	string
`website`	string or null
`logo_url`	string or null
`domain_name`	string or null
`send_domain_url`	boolean or null	A flag despite the name, not a URL.
`active`	boolean
`go_live_date`	string (date) or null	`YYYY-MM-DD`.
`created_at`	string (date-time) or null
`updated_at`	string (date-time) or null

Error Response¶

Code: 400 Bad Request

{
  "code": "bad_request",
  "message": "Validation failed",
  "errors": [
    {
      "field": "patient_id",
      "message": "must be a string"
    }
  ]
}

Every error has the same shape — a machine-readable code, a message, and an errors[] array that's empty when there's nothing field-specific to report. The HTTP status is authoritative.

Status	`code`	Meaning
`400 Bad Request`	`bad_request`	The request body or parameters failed validation. `errors[]` names the offending fields.
`401 Unauthorized`	`unauthorized`	The access token is missing, malformed or expired.
`403 Forbidden`	`forbidden`	The request references a resource outside the token's organisation or clinic scope.
`404 Not Found`	`not_found`	No such resource, or it's outside your scope.
`429 Too Many Requests`	`rate_limited`	Rate limit exceeded. Back off and retry.
`500 Internal Server Error`	`internal_error`	Unexpected server error.
`502 Bad Gateway`	`upstream_error`	Upstream service failed or timed out.