Skip to main content

Try JSON:API for yourself

Change the controls to see how includes and field selection affect the same contact request. The example is illustrative and runs entirely in your browser.

Illustrative data · No credentials needed · No API requests are sent

Your request

GET /jsonapi/contacts/1001

Response structure

{
  "data": {
    "type": "contacts",
    "id": "1001",
    "attributes": {
      "firstName": "Alex",
      "lastName": "Morgan",
      "email": "alex@example.com"
    },
    "relationships": {
      "contactAddress": {
        "data": [
          {
            "type": "contact-address",
            "id": "2001"
          }
        ]
      }
    }
  }
}

The relationship contains an identifier. It does not contain the address details; include the address to retrieve them together.

This example omits optional links and metadata to keep the structure clear. Actual values and available fields depend on the record and your access.

What to notice​

  • The contact remains the primary data resource in every example.
  • Relationship linkage identifies the address by type and id.
  • Including the address adds its details to included, rather than nesting them under the contact.
  • Sparse fieldsets reduce attributes and relationships; they do not change the record's identity.
  • When both controls are selected, contactAddress stays in the contact fieldset so its link is retained.

For a real request, use your assigned API URL, bearer token and adviser context. Try Postman with the collection setup guide or the API reference.