---
title: "List enrollment statuses"
method: GET
path: "/enrollment-statuses"
tags: ["EnrollmentStatuses"]
---

# List enrollment statuses

`GET /enrollment-statuses`

## Request

- Base URL: `https://api.sandbox.zusapi.com/zap-data-subscriptions`
- URL: `https://api.sandbox.zusapi.com/zap-data-subscriptions/enrollment-statuses`
- Auth: none declared

The enrollment status is a linkage between a ZAP subscription package and a patient. If a status object does not exist for a patient/package combination, which indicates that the patient is not enrolled in that package.

## Query parameters

- `pagination` object: All list endpoints support offset-based pagination. For example: `page[count]=50&page[offset]=100` will return 50 enrollment statuses from the third page of results.
  - `page[count]` string
  - `page[offset]` string
- `include` string: Include related resources in the response. Supported values: - zap-data-subscriptions/package: Include package details in the response
- `filter` object: Statuses can be filtered by one or more fields, including by patient, by package, and by enrollment status .
  - `patient-id` string
  - `package-id` string
  - `builder-id` string: The Builder ID of another builder on whose behalf the caller is acting. This requires that the calling user has access to that builder, such as a cross-builder. example: 283d4e07-ad6f-4296-ad1e-26242a8f7815
  - `status` string

## Response `200`

Successful operation

- object
  - `data` EnrollmentStatusRead[]
    - `type` string
    - `id` string
    - `attributes` object
      - `provider` object
        - `resourceId` string, uuid: The Provider resource ID corresponding to a user who has a treatment relationship with the patient.
        - `npi` string: The NPI of the user / organization who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `firstName` string: The first name of the user who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `lastName` string: The last name of the user who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `name` string: The full name of the user / organization who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed. Note: If you use individual NPI, please use 'firstName' and 'lastName'.
        - `role` string: The role of the user / organization who has a treatment relationship with the patient - it can be string or SNOMED CT code as a string. If present, the 'resourceId' field is not allowed.
      - `practitioner` object: This field is deprecated.
        - `resourceId` string, uuid: The Practitioner resource ID corresponding to a user who has a treatment relationship with the patient.
        - `npi` string: The NPI of the user / organization who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `firstName` string: The first name of the user who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `lastName` string: The last name of the user who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed.
        - `name` string: The full name of the user / organization who has a treatment relationship with the patient. If present, the 'resourceId' field is not allowed. Note: If you use individual NPI, please use 'firstName' and 'lastName'.
        - `role` string: The role of the user / organization who has a treatment relationship with the patient - it can be string or SNOMED CT code as a string. If present, the 'resourceId' field is not allowed.
      - `createdAt` string: The timestamp (in ISO 8601 format) at which enrollment status was created. This field is managed by Zus, and updates will be ignored.
    - `relationships` object
      - `patient` object: Reference an existing Zus patient.
        - `data` object
          - `type` string: The data type of this object. This should always be "fhir/Patient"
          - `id` string: The patient ID
      - `package` PackageRelationshipCreate: The package to which this status refers when creating an Enrollment status.
        - `data` object
          - `type` string: The data type of this object. This should always be "zap-data-subscriptions/package"
          - `id` string: The package ID
      - `createdBy` object: The Zus user responsible for creating this enrollment status. This field is managed by Zus, and requests to manually update the field will result in an error being returned.
        - `data` object
          - `type` string
          - `id` string
          - `meta` object
            - `userEmail` string

## Other responses

- `500`: Error condition

---

[API](https://skmtc.dev/zushealth/apis/zap-data-subscriptions.md) - [All operations](https://skmtc.dev/zushealth/apis/zap-data-subscriptions/llms.txt) - [OpenAPI document](https://skmtc.dev/zushealth/apis/zap-data-subscriptions/revisions/53c881ee99ff?raw)