Organisations

List partner organisations

A GET to the organisations endpoint is used to get all the organisations of a partner.

The returned list of organisations is filtered for the partner based on the API key in use.

The following parameter is an optional additional filter. In the absence of any filter parameters, it will return all organisations that this API key has access to.

get/api/v2/partner/organisations

Request

  • Base URL: http://localhost:5100
  • URL: http://localhost:5100/api/v2/partner/organisations
  • Auth: API key in header Authorization

Query parameters

pageinteger

Page number

per_pageinteger

Number of organisations per response page

partner_client_idstring

A way to specify a single organisation. The returned list will always contain one organisation, or an empty list if it matches no client id of any organisation related to the API key in use.

The partner_client_id is an identifier value, or the set of values, one for each client organisation, that may have been set out (usually chosen by the partner) at the time of originally setting up the partner. If using SAML SSO, the same values are used in the ClientId SAML attribute.

Response

Organisations fetched successfully

successboolean

Example response

{
  "success": true,
  "organisations": [
    {
      "id": 1,
      "name": "Acme Ltd",
      "enabled": true,
      "staff_count": "150",
      "organisation_type": "NHS",
      "terc_eap": "level_3",
      "terc_eap_code": "ABC123",
      "partner_id": 42,
      "partner_client_id": "partner-x-client-789",
      "login_url": "https://acme.example.com/login",
      "portal_url": "https://acme.example.com",
      "subdomain": "acme",
      "contract_start_date": "2025-01-01",
      "contract_end_date": "2025-12-31",
      "created_at": "2025-05-10T08:30:00Z",
      "updated_at": "2025-05-11T12:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.