GET/transactional-api/organisation-details

Get Organisation Details

Returns organisation-level details for the requesting practice, including its correspondence address.

Authorization: Bearer token (JWT). See Authentication.

Responses

200 Details of the local organisation.

Response fields

Field	Type	Description
`name`	`string`
`shortName`	`string` (nullable)
`emailAddress`	`string` (nullable)
`telephoneNumber`	`string` (nullable)
`odsCode`	`string` (nullable)
`tenantId`	`string`	Medicus-specific tenant identifier for this organisation.
`correspondenceAddress.line1`	`string` (nullable)
`correspondenceAddress.line2`	`string` (nullable)
`correspondenceAddress.line3`	`string` (nullable)
`correspondenceAddress.locality`	`string` (nullable)
`correspondenceAddress.administrativeArea`	`string` (nullable)
`correspondenceAddress.postalCode`	`string` (nullable)
`correspondenceAddress.country`	`string` (nullable)

{
  "name": "Dr MA Baird's Practice",
  "shortName": "Baird Practice",
  "emailAddress": "caitriona.mccormack@medicus.health",
  "telephoneNumber": "07958 662735",
  "odsCode": "A81001",
  "tenantId": "ea6614",
  "correspondenceAddress": {
    "line1": "Flat 6",
    "line2": "16-19",
    "line3": "Commercial Row",
    "locality": "Doc Penfro",
    "administrativeArea": "Pembrokeshire",
    "postalCode": "SA72 6LA",
    "country": "England"
  }
}

Responses​

Responses