patients

List patients in a clinic

Lists patients in a clinic

get/patients

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/patients
  • Auth: none declared

Query parameters

programStatus'prospective' | 'active' | 'former' required

Patient Program status filter

limitinteger

How many patients to return at one time (max 20).

offsetinteger

How many patients to skip before returning the limit number of patients. Use this to page.

Response

success

Example response

{
  "meta": {
    "count": 1,
    "totalCount": 100
  },
  "patients": [
    {
      "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
      "createdAt": "2024-01-01T00:00:00Z",
      "name": {
        "first": "Doe",
        "last": "John",
        "pronouns": "he/him",
        "chosenName": "Johnny"
      },
      "careTeam": {
        "primaryClinician": {
          "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
          "email": "johndoe@ritclinic.ritten.io",
          "first": "Doe",
          "last": "John",
          "lastAccessedAt": "2024-01-15T14:32:00Z"
        }
      },
      "phones": [
        "+15555555555"
      ],
      "emails": [
        "john@example.com"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.