Awell Docs

Make your first authenticated request to the Awell Orchestration API, covering the endpoint, the auth header, and a working query.

The Orchestration API is a single GraphQL endpoint your systems call to read and write care-orchestration data: patients, care flows, activities, and more. This page walks you through your first request end to end.

Before you start

You need an API key. See Authentication to obtain one and learn how to send it.

1. Find the endpoint

One GraphQL endpoint per environment and region. If you are building, that is Sandbox:

https://api.sandbox.awellhealth.com/orchestration/m2m/graphql

Production is regional — EU, US or UK. See Environments for all four addresses and for which one your data lives in.

2. Send an authenticated request

POST to that endpoint with your key in an apiKey header and a JSON body holding query and, if the query takes any, variables:

curl https://api.sandbox.awellhealth.com/orchestration/m2m/graphql \
  -H 'Content-Type: application/json' \
  -H 'apiKey: YOUR_API_KEY' \
  -d '{"query": "query { patients(pagination: {count: 1, offset: 0}) { patients { id } } }"}'

The value is the key itself — no Bearer prefix. See Authentication for where keys come from and why they belong in a backend service.

3. Run your first query

Retrieve a single patient by Awell patient ID:

query GetPatient($id: String!) {
  patient(id: $id) {
    patient {
      id
      profile {
        first_name
        last_name
        email
      }
    }
  }
}

Variables:

{
  "id": "<AWELL_PATIENT_ID>"
}

Every response carries a code and a success boolean alongside its data. See Errors for how to read them.

Next steps

Browse the full operation catalog under Reference (for example, Patients and Care flows).
Learn how list queries page through results in Pagination.

Getting started