Relationships

When an object has related items, for example (an address is attached to a profile), there will be a relationships key in the response, which contains details about the type and ID of any related items.

The relationships key and specific related objects may be required when creating or updating an object. Check the Data Type documentation for each object for more information.

Example Object with Relationships

{
  "data": {
    ...
  },
  "relationships": {
    "account": {
      "data": {
        "type": "accounts",
        "id": "{ACCOUNT_ID}"
      }
    },
    "profile": {
      "data": {
        "type": "profiles",
        "id": "{PROFILE_ID}"
      }
    }
  }
}