Gets a single referrer by id

GET/jsonapi/referrers/{id}

Where id is the identifier of the referrer

Access

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

Request parameters

id path required

·idstring

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/referrers/{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": "referrers",
    "id": "1001",
    "attributes": {
      "referrerOrganisationName": "string",
      "referrerName": "string"
    }
  }
}

200 responseobjectReferrerDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredReferrer ↗

includedarray · nullableread only

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