Async Endpoints V1 — Developer Guide

These endpoints retrieve records asynchronously. When called, they return the first 10 matching results immediately in the HTTP response body, while simultaneously streaming all matching records to the Streaming API using a routing key.

Async requests are limited to a pageSize of 10 for the immediate response. All async endpoints require an Organization-ID header.

The following async endpoints are available:

• GET /v1/patients/async
• GET /v1/events/async
• GET /v1/appointments/async
• GET /v1/imageattachments/async
• GET /v1/locationproductionnetschedule/async

Reference: Patients (V1) Endpoint Documentation

Retrieves patients asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API.

Note: patientStatus valid values: NEW, ACTIVE, NON-PATIENT, INACTIVE, DUPLICATE, DISMISSED, DECEASED. gender valid values: M, F, O.

Ordering: Results on this async endpoint are returned in descending id order (newest first). The synchronous GET /v1/patients bulk endpoint pages by ascending id. See Patients V1 — Developer Guide for the full bulk GET filter list (including id->[…], which is documented on sync bulk GET but not listed here).

Upcoming Breaking Change: preferredLocation.id (as a list of IDs or ["ALL"]) will become a required filter. Omitting it currently defaults to all locations.

Date-limiting filters: If you do not supply a date-limiting filter, one may be applied automatically using lastModified. Supply your own date bound for predictable results. The following filter keys count as date-limiting: lastModified, createdDate, and updatedDate.

Fetch all patients modified after a date:

GET /api/v1/patients/async?filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]

Paginate using lastId:

GET /api/v1/patients/async?lastId=22000012345678&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]

Reference: Events (V1) Endpoint Documentation

Retrieves events asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API.

For full Events V1 documentation — including all filter keys, create/update/delete semantics, recurrence, and field reference — see the Events V1 — Developer Guide.

Fetch events modified after a date at a specific location:

GET /api/v1/events/async?filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]

Paginate using lastId:

GET /api/v1/events/async?lastId=500&filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]

Reference: Appointments (V1) Endpoint Documentation

Retrieves appointments asynchronously. Returns the first 10 results immediately and streams all matching records to the Streaming API.

Upcoming Breaking Change: location.id (as a list of IDs or ["ALL"]) will become a required filter. Omitting it currently defaults to all locations.

Note: status valid values: LATE, HERE, READY, CHAIR, COMPLETED, CONFIRMED, UNCONFIRMED, NO_SHOW, BROKEN, LEFT_MESSAGE, CHECKOUT, WILL_CALL, UNREACHABLE, CANCELLEDBYOFFICE.

Fetch appointments modified after a date at a specific location:

GET /api/v1/appointments/async?filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]

Paginate using lastId:

GET /api/v1/appointments/async?lastId=8000052360370&filter=lastModified>=2025-01-01T00:00:00Z,location.id->[64000000000004]

Reference: ImageAttachments (V1) Endpoint Documentation

Returns a list of image attachments with async support via the Streaming API.

Note: Async retrieval for image attachments is only available via this /async endpoint. The regular /v1/imageattachments endpoint does not support async or streaming.

Fetch image attachments by insurance claim:

GET /api/v1/imageattachments/async?filter=insuranceClaim.id==456

Fetch a specific set of attachments by ID:

GET /api/v1/imageattachments/async?filter=id->[123,124,125]

Reference: Production Net Schedule Report (V1) Endpoint Documentation

Returns production total net schedule reports asynchronously based on filter criteria.

Note: provider.id, patient.id, and appointment.id are mutually exclusive — only one may be used per request.

Upcoming Breaking Change: location.id (as a list of IDs or ["ALL"]) will become a required filter. Omitting it currently defaults to all locations.

Fetch production net schedule report for a date range at a location:

GET /api/v1/locationproductionnetschedule/async?filter=fromDate==2025-01-14,range==7,location.id->[64000000000004]

Fetch report for a specific provider:

GET /api/v1/locationproductionnetschedule/async?filter=fromDate==2025-01-14,provider.id==789

All async endpoints return a 200 response with the following top-level structure:

lastId is the recommended approach for iterating through large result sets on async endpoints. It uses the record's id as a cursor rather than an offset.

Send your first request without lastId:

GET /api/v1/patients/async?filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]

Take the id of the last record in the returned data array and pass it as lastId in the next request:

GET /api/v1/patients/async?lastId=22000012345678&filter=lastModified>=2025-01-01T00:00:00Z,preferredLocation.id->[64000000000004]

Continue until the response returns an empty data array or no-more-data indicator.

Async endpoints deliver the complete result set to the Streaming API in parallel with the immediate HTTP response. To consume the streamed data, your application must be subscribed to the Streaming API.

See the Streaming API Webhooks Setup Guide for full setup instructions.