Gets contacts via a single related deal

GET/jsonapi/deals/{id}/contacts

Where id is the identifier of the deal

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/deals/{id}/contacts" \
  --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": "contacts",
      "id": "1001",
      "attributes": {
        "mobile": "+61400000000",
        "title": "string",
        "firstName": "Alex",
        "middleName": "string",
        "lastName": "Morgan",
        "preferredName": "Alex",
        "homePhone": "+61400000000",
        "businessPhone": "+61400000000",
        "email": "alex@example.com",
        "secondaryEmail": "alex@example.com",
        "maritalStatus": "Single",
        "gender": "Male",
        "updated": "2026-01-15T09:00:00Z",
        "hasMarketingConsent": false,
        "dateOfBirth": "1990-01-15",
        "isPrimary": false,
        "role": "Adult",
        "created": "2026-01-15T09:00:00Z"
      }
    }
  ]
}

200 responseobjectContactsDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataarrayrequired

includedarray · nullableread only

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