---
title: "Search for an organisation"
method: GET
path: "/Organization"
---

# Search for an organisation

`GET /Organization`

## Overview
Use this endpoint to search for organisations or sites. Site codes which are supported for certain organisations can also be accessed here, there is no separate endpoint for sites. 

A FHIR Organization resource will be provided for each search result.

You can search for information about an organisation using one or more of their: 

  * ODS code 
  * last change date 
  * name 
  * active or inactive status 
  * address, city or postcode  
  * organisation's primary role using RoleID, such as RO197 (NHS Trust) or RO167 (Optical Site) 
  * organisation's non-primary role using RoleID, such as RO7 (Hospice) or RO318 (Integrated Care Board) 
  
This API returns the following details for an organisation: 

  * organisation - ODS code, name, last change date, status if active or inactive , record class (organisation or site), record use type; A complete record or a reduced record included solely for referential integrity.
  * address - house or flat number, line 1, line 2, line 3, town, postcode, Unique Property Reference Number (UPRN) and country
  * contacts - website and telephone (where available)
  * roles - primary and non-primary roles including legal and operational start and end dates 

You can also request any related relations resources using the `_revinclude` parameter to return an OrganizationAffiliation Resource. 

You can try out the sandbox using the 'Try this API' feature on this page. (Coming Soon!)

Alternatively, you can try out the sandbox using our Postman collection (placeholder link):

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/32547823-005ebee4-7510-44c3-bb0e-58f26b2ba747)

## Query parameters

- `_id` string
- `identifier` string
- `lastChangeDate` string
- `name` string
- `name:contains` string
- `name:exact` string
- `active` boolean
- `address-postalcode` string
- `address-postalcode:contains` string
- `address-postalcode:exact` string
- `address-city` string
- `address-city:contains` string
- `address-city:exact` string
- `address-country` string
- `roleCode` string
- `roleCode:not` string
- `activeRoleCode` string
- `_count` string
- `_summary` 'count'
- `_offset` string

## Response `200`

Valid request that returns a FHIR Organization resource(s) that match the search criteria (which may be 0).

## Other responses

- `4XX` — An error occurred as follows: | HTTP Code | issue.severity | issue.code | issue.details.code | issue.details.display | |------------ |----------------|---------------|---------------------|--------------------- | |400 |error |invalid |HAPI-1940 |Invalid Date/Time/Quantity format | |400 |error |invalid |HAPI-0524 |Unknown Search Parameter| |404 |error |invalid |HAPI-2001 |Organization not found | |405 |error |method not allowed|HAPI-0427 |Method Not Allowed |

---

[API](https://skmtc.net/nhs/apis/organisation-data-service-fhir-api.md) · [All operations](https://skmtc.net/nhs/apis/organisation-data-service-fhir-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nhs/organisation-data-service-fhir-api/versions/6cf3c5d3b6d3/schema)