# Retrieves a specific organization by its unique identifier

`GET /api/configuration/organisations/{all}`

- **Success:** `200 OK`
- **Products:** Operator (`FOH`)
- **Features:** Front of House Generic Access (`FOHGENERIC`)

HTML version: [Retrieves a specific organization by its unique identifier](https://support.gladstonesoftware.cloud/reference/configuration/retrieves-a-specific-organization-by-its-unique-identifier)

## Overview

Returns one organisation — the legal or commercial entity above sites, carrying the name, registered
address, VAT identifier and logo used on customer-facing documents — together with the sites mapped
to it.

The response is identical in shape to one element of
[Retrieve all organisations](retrieves-all-organizations-configured-in-the-system.md),
so prefer the list when you need more than one; there is no batching here.

An id that does not exist returns `404`, which makes this usable as an existence check — with one
exception. **Passing `0` returns the first organisation rather than a `404`**, because `0` is
treated as "no filter". Never pass an id you have not read from the platform.

## Endpoint

`GET {base_url}/api/configuration/organisations/{all}`

`{base_url}` is the environment URL issued to your integration. See [Authenticating with Gladstone APIs](../../guides/authenticating-with-gladstone-apis.md).

## Path parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `organisationId` | integer (int32) | Yes | The organisation to retrieve, taken from `id` in [Retrieve all organisations](retrieves-all-organizations-configured-in-the-system.md). An unknown id returns `404`. **`0` is not safe to send**: it is treated as "no filter" and returns whichever organisation comes back first, not an error. |

## Sample request

```bash title="cURL"
curl -X GET '{base_url}/api/configuration/organisations/{all}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'
```

## Response fields

| Field | Type | Description |
|-------|------|-------------|
| `id` | integer (int32) | The organisation's identifier. Check it against the id you requested if there is any chance of sending `0`. |
| `type` | string | What kind of entity this is: `operator` for the business running the centres, or `partner` for an associated organisation. Those are the only two values accepted on create or update, compared case-insensitively. Maximum 20 characters. |
| `name` | string | The organisation's trading name, as displayed. Maximum 255 characters. Not necessarily the registered name — see `legalName`. |
| `legalName` | string | The registered legal name of the entity, for documents that must name the company rather than the brand. Maximum 255 characters. May be `null` where only a trading name was recorded. |
| `description` | string | Free-text notes about the organisation, maximum 255 characters. `null` when none was entered. |
| `websiteUrl` | string | The organisation's public website address, maximum 255 characters. Returned as entered — it is not validated as a well-formed URL, so treat it as untrusted text before rendering it as a link. |
| `logoUrl` | string | Address of the organisation's logo image, maximum 255 characters. Not validated as a URL and not hosted by this endpoint. `null` when no logo was set. |
| `address` | object | The organisation's registered or trading address. Always present as an object, but every field inside it is individually optional, so expect an object of nulls rather than a missing address. |
| `address.addressLine1` | string | First line of the address, maximum 100 characters. |
| `address.addressLine2` | string | Second line of the address, maximum 100 characters. `null` when unused — the lines are not compacted, so do not assume line 2 is filled before line 3. |
| `address.addressLine3` | string | Third line of the address, maximum 100 characters. Often `null`. |
| `address.town` | string | Town or city, maximum 100 characters. |
| `address.region` | string | County, state or region, maximum 100 characters. |
| `address.postCode` | string | Postal code, maximum 25 characters — the shortest of the address fields, and the one most likely to reject an overseas value on write. Returned as entered, with no formatting or validation applied. |
| `address.country` | string | Country as free text, maximum 100 characters — not an ISO country code, and not validated against a list. |
| `contact` | object | The organisation's general contact details. Always present as an object, with both fields individually optional. |
| `contact.telephone` | string | Contact telephone number as free text, maximum 100 characters. No format is enforced, so expect spacing and country codes to vary. |
| `contact.email` | string | Contact email address, maximum 255 characters. Only the length is checked — the address is not validated, so it may not be deliverable or even well-formed. |
| `vatId` | string | The organisation's VAT registration identifier, maximum 50 characters, returned as entered with no format check. `null` for organisations that are not VAT registered or where it was not recorded. |
| `isActive` | boolean | Whether the organisation is in use. `false` means retired rather than unknown. An inactive organisation is still returned with `200` — this endpoint does not treat it as missing. |
| `sites` | array of string | The site codes mapped to this organisation, which is how you tell which trading entity a site belongs to. Empty rather than `null` when no sites are mapped. |

## Sample response

```json title="200 OK"
{
  "id": 12345,
  "type": "string",
  "name": "string",
  "legalName": "string",
  "description": "string",
  "websiteUrl": "string",
  "logoUrl": "string",
  "address": {
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "town": "string",
    "region": "string",
    "postCode": "string",
    "country": "string"
  },
  "contact": {
    "telephone": "string",
    "email": "member@example.com"
  },
  "vatId": "string",
  "isActive": true,
  "sites": [
    "string"
  ]
}
```

## Errors

| Status | Meaning | When |
|--------|---------|------|
| `404` | Not found | No organisation exists with that id. The body is the plain string `Organisation {organisationId} could not be found` — note there is no full stop. An id of `0` does **not** produce this. |
| `500` | Internal server error | An unexpected server-side failure while reading the organisation. The body is a generic platform error rather than a message specific to this endpoint. |