Gets deal via a single related participants in a deal

GET/jsonapi/deal-participants/{id}/deal

Where id is the identifier of the participants in a 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/deal-participants/{id}/deal" \
  --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": "deals",
    "id": "1001",
    "attributes": {
      "updated": "2026-01-15T09:00:00Z",
      "created": "2026-01-15T09:00:00Z",
      "dates": {
        "settled": "2026-01-15",
        "lodged": "2026-01-15",
        "financeClause": "2026-01-15",
        "notProceeding": "2026-01-15",
        "approved": "2026-01-15",
        "preApproved": "2026-01-15",
        "conditionallyApproved": "2026-01-15",
        "preApprovedExpiry": "2026-01-15",
        "estimatedSettled": "2026-01-15"
      },
      "totalLoanAmount": 1,
      "name": "string",
      "dealStatus": "NewLeads",
      "opportunity": {
        "proposedLoanAmount": 1,
        "securityAmount": 1,
        "summaryNotes": "string",
        "loanPurpose": "string"
      },
      "splits": [
        {
          "loanTermYears": 1,
          "rateType": "string",
          "loanStructureType": "PrincipalInterest",
          "amount": 1,
          "capitaliseLmi": false,
          "lmiPremium": 1,
          "amountInclLmi": 1,
          "interestRate": 1,
          "rateTypePeriodMonths": 1,
          "paymentAmount": 1,
          "fixedRateStartDate": "2026-01-15",
          "fixedRateEndDate": "2026-01-15",
          "interestOnlyStartDate": "2026-01-15",
          "interestOnlyEndDate": "2026-01-15",
          "repaymentHolidayStartDate": "2026-01-15",
          "repaymentHolidayEndDate": "2026-01-15"
        }
      ],
      "lenderName": "string",
      "customStatusName": "string",
      "dealType": "Residential",
      "auRationale": {
        "summary": "string"
      },
      "nzRationale": {
        "summary": "string",
        "lenderPreferences": "string",
        "loanStructure": "string",
        "productFeatures": "string"
      }
    }
  }
}

200 responseobjectDealDocument ↗

metaobjectread only

jsonApiobjectread only

linksall ofread only

dataobjectrequiredDeal ↗

includedarray · nullableread only

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