Gets a single organisation by id

GET/jsonapi/organisations/{id}

Where id is the identifier of the organisation

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

·idinteger

format: int32

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request GET "${API_BASE_URL}/jsonapi/organisations/{id}" \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "UserId: $ADVISER_CONTACT_ID" \
  --header 'Accept: application/vnd.api+json'

Responses

200 response

application/vnd.api+json

Example response body

Generated from the OpenAPI Specification with illustrative values. Shows primary data and attributes where defined; optional links, relationships and included resources are omitted. Actual values and returned fields depend on your request and access.

{
  "data": {
    "type": "organisations",
    "id": "1001",
    "attributes": {
      "brandedCategory": "string",
      "primaryBrandColour": "string",
      "name": "string",
      "tradingName": "string",
      "website": "string",
      "companyEmail": "alex@example.com",
      "isBrokerSearchVisible": false,
      "status": "string",
      "slug": "string",
      "businessNumber": "string",
      "companyNumber": "string",
      "officeDisplayName": "string",
      "emailForCommissions": "alex@example.com",
      "phone": "+61400000000",
      "fax": "string",
      "brandLogoUrl": "https://example.com/"
    }
  }
}

200 responseobjectOrganisationDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredOrganisation ↗

includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.