# Get all events

Endpoint: GET /events
Version: 2024-12-10
Security: BearerAuth

## Query parameters:

  - `iterator` (string)

  - `limit` (integer)
    Maximum number of events to return, anywhere from 1 to 250. Default is 250.

## Response 200 fields (application/json):

  - `events` (array)

  - `events.id` (string, required)

  - `events.name` (string, required)
    Name of the event that occurred. Additional information specific to each event is available in payload.
    Enum: "accepted", "rejected", "ordered", "dispensed", "delivered"

  - `events.prescription_identity` (object, required)
    This information should be used to match events to prescriptions as they are read from the events endpoint.

  - `events.prescription_identity.patient_first_name` (string, required)

  - `events.prescription_identity.patient_last_name` (string, required)

  - `events.prescription_identity.patient_state` (string, required)

  - `events.prescription_identity.patient_dob` (string, required)

  - `events.prescription_identity.erx_message_id` (string,null)

  - `events.prescription_identity.prescriber_npi` (string, required)

  - `events.prescription_identity.written_date` (string, required)

  - `events.prescription_identity.drug_ndc` (string, required)

  - `events.pharmacy_npi` (string, required)
    The NPI of the Gifthealth pharmacy that is managing this prescription.

  - `events.occurred_at` (string, required)
    The time that the event happened.

  - `events.api_version` (string, required)
    The version of the API when this event was published. This is specified by the subscription under which the event was published. To get events for a newer API version, cancel the existing subscription for the script and then create a new one through the newer API version.

  - `events.subscription_id` (string, required)
    The subscription that triggered this event to be published.

  - `events.payload` (any, required)
    Additional information about the event. This will be an empty object ({}) if there is no additional information for the event type.

  - `meta` (object)

  - `meta.iterator` (string,null, required)

  - `meta.limit` (integer, required)

  - `meta.done` (boolean, required)

## Response 401 fields (application/json):

  - `error` (string)