Gets referrerOrganisation via a single related contact group

GET/jsonapi/contact-groups/{id}/referrerOrganisation

Where id is the identifier of the contact group

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/contact-groups/{id}/referrerOrganisation" \
  --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": "referrer-organisation",
    "id": "1001",
    "attributes": {
      "referrerOrgName": "string"
    }
  }
}

200 responseobjectReferrerOrganisationDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredReferrerOrganisation ↗

includedarray · nullableread only

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