You can include additional resources using the with query parameter in your requests. This parameter accepts a list of one or more related resources, returning them in conjunction with the primary resource.

Refer to the API documentation to access lists of available extensions within each section. Response examples demonstrate how with query parameters can be used to enhance the returned data. More details can be found in the video below:

Example Usage

Suppose you wish to obtain a list of facilities associated with your API client following authorization. You would make a GET request to the following endpoint:

GET https://www.{domain}/api/v3/integration/facilities/{facility_id}

Standard response sample:

{
  "_items": [
    {
      "id": 1,
      "name": "Sample hospital"
    },
    {
      "id": 2,
      "name": "Another sample hospital"
    }
  ]
}

To also retrieve a list of doctors employed at a specific facility, extend your request using the with parameter:

GET https://www.{domain}/api/v3/integration/facilities/{facility_id}?with=facility.doctors

Expanded response with doctors included:

{
  "id": 1,
  "name": "Sample hospital",
  "doctors": {
    "_items": [
      {
        "id": 123,
        "name": "Sample",
        "surname": "Doctor 123"
      },
      {
        "id": 234,
        "name": "Sample",
        "surname": "Doctor 234"
      }
    ]
  }
}