ECLINICALWORKS

Fetch appointments by range

List appointments for one or more providers over a date range.

POSThttps://api.ontross.com/api/integrations/ecw/fetch-appointments-by-range

Request Fields

input.provider_ids

array

required

Provider ids whose schedules are read, from fetch-providers. No duplicates.

Example

["6086","6102"]

input.start_date

string

required

First included calendar day of the requested schedule, in MM/DD/YYYY format.

Example

"06/17/2026"

input.end_date

string

required

Last included calendar day, in MM/DD/YYYY format, no earlier than the first.

Example

"06/19/2026"

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

Output Fields

provider_ids

array

Provider ids the schedule was read for, as requested.

Example

["6086","6102"]

start_date

string

First included schedule day, echoed as MM/DD/YYYY.

Example

"06/17/2026"

end_date

string

Last included schedule day, echoed as MM/DD/YYYY.

Example

"06/19/2026"

count

integer

Number of schedule entries included in this response.

Example

2

encounters

array

The providers' appointments across the requested date range.

encounters[].encounterId

string

Encounter being read or written, from fetch-appointments.

Example

"100001"

encounters[].reason

string

Why the call or hospitalization happened, saved as row text.

Example

"Annual wellness visit"

encounters[].title

string

Appointment title eCW shows on the schedule.

Example

"Annual wellness visit"

encounters[].patientId

string

Patient chart being read or written, from fetch-patients.

Example

"100002"

encounters[].patientName

string

Name text matched against the live patient lookup.

Example

"Example,Jordan"

encounters[].patientPhoneNumber

string

Phone number copied onto the appointment record.

Example

"202-555-0142"

encounters[].patientEmail

string

Email copied onto the appointment record.

Example

"jordan.example@example.com"

encounters[].patientUpPhone

string

Raw eCW patientUpPhone value carried on the appointment.

Example

"903-278-8495"

encounters[].patientDob

string

Date of birth copied onto the appointment.

Example

"01/05/2012"

encounters[].patientPreferredName

string

Preferred name copied onto the appointment record.

Example

"Jordan"

encounters[].doctorName

string

Provider name, the appointment's provider or the patient's assigned one.

Example

"Example,Alex"

encounters[].doctorId

string

Provider identifier, a string on appointments and an integer on orders.

Example

"100003"

encounters[].facilityName

string

Facility where the appointment is booked.

Example

"Example Clinic"

encounters[].facilityId

string

Facility the telephone encounter is booked at, from the facility list.

Example

"100004"

encounters[].start

string

Appointment start in the facility's local time, as eCW returns it.

Example

"2026-01-15T09:00:00"

encounters[].end

string

Appointment end in the facility's local time, as eCW returns it.

Example

"2026-01-15T09:30:00"

encounters[].timezone

string

Facility timezone eCW reports for this appointment, e.g. CDT. Null when eCW omits it.

Example

"CDT"

encounters[].start_at

string

Appointment start as ISO-8601 with a UTC offset, derived from timezone. Null when the timezone is absent or unrecognised.

Example

"2026-10-06T09:00:00-05:00"

encounters[].end_at

string

Appointment end as ISO-8601 with a UTC offset. Null when the timezone is absent or unrecognised.

Example

"2026-10-06T09:30:00-05:00"

encounters[].generalNotes

string

Replaces the appointment's General Notes entirely, and empty string clears it.

Example

"Bring updated medication list."

encounters[].visitType

string

Visit type such as office visit or telephone.

Example

"Office visit"

encounters[].visitStatus

string

New appointment status, limited to check-out and no-show here.

Example

"scheduled"

encounters[].billableVisitStatus

boolean

Whether the visit status counts as billable.

Example

true

encounters[].color

string

Calendar color eCW paints this appointment block.

Example

"#66CC99"

encounters[].encLock

string

Whether the encounter is locked against further edits.

Example

"0"

encounters[].eligibilityMessage

string

Message from the last insurance eligibility check.

Example

"Coverage active"

encounters[].groupId

string

Group appointment this slot belongs to, empty when individual.

Example

"9001501"

encounters[].claimRequired

boolean

Whether a claim must be generated for this appointment.

Example

true

encounters[].transitionOfCare

string

Raw eCW transition of care flag on the appointment.

Example

"0"

encounters[].encType

string

Encounter type code, an integer or string depending on operation.

Example

"1"

encounters[].dx

string

Diagnosis text attached to the appointment, often empty.

Example

"Essential hypertension"

encounters[].RTServiceAuthorization

string

Real-time service authorization eCW returned for the visit.

Example

"AUTH9001502"

encounters[].selfPay

string

Raw eCW self pay flag on the appointment.

Example

"0"

encounters[].deptId

string

Department eCW books this appointment under.

Example

"14"

encounters[].resources

string

Bookable resource list, or the appointment's raw resource string.

Example

"247093"

encounters[].ShowInsEligOnAppt

boolean

Whether eCW shows insurance eligibility on the appointment screen.

Example

false

encounters[].userId

integer

Raw eCW userId carried on the appointment record.

Example

100005

encounters[].eligibilityStatus

string

Result of the last insurance eligibility check.

Example

"Active"

encounters[].POS

string

Place of service code billed for the visit.

Example

"11"

encounters[].newPt

string

Whether the appointment is for a new patient.

Example

"0"

encounters[].status

string

Additional source disposition value passed through without interpretation.

Example

"Active"

Code

curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ecw/fetch-appointments-by-range \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"provider_ids":["6086","6102"],"start_date":"06/17/2026","end_date":"06/19/2026"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "provider_ids": [
      "6086",
      "6102"
    ],
    "start_date": "06/17/2026",
    "end_date": "06/19/2026"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "provider_ids": [
      "6086",
      "6102"
    ],
    "start_date": "06/17/2026",
    "end_date": "06/19/2026",
    "count": 2,
    "encounters": [
      {
        "encounterId": "100001",
        "reason": "Annual wellness visit",
        "title": "Annual wellness visit",
        "patientId": "100002",
        "patientName": "Example,Jordan",
        "patientPhoneNumber": "202-555-0142",
        "patientEmail": "jordan.example@example.com",
        "patientUpPhone": "903-278-8495",
        "patientDob": "01/05/2012",
        "patientPreferredName": "Jordan",
        "doctorName": "Example,Alex",
        "doctorId": "100003",
        "facilityName": "Example Clinic",
        "facilityId": "100004",
        "start": "2026-01-15T09:00:00",
        "end": "2026-01-15T09:30:00",
        "timezone": "CDT",
        "start_at": "2026-10-06T09:00:00-05:00",
        "end_at": "2026-10-06T09:30:00-05:00",
        "generalNotes": "Bring updated medication list.",
        "visitType": "Office visit",
        "visitStatus": "scheduled",
        "billableVisitStatus": true,
        "color": "#66CC99",
        "encLock": "0",
        "eligibilityMessage": "Coverage active",
        "groupId": "9001501",
        "claimRequired": true,
        "transitionOfCare": "0",
        "encType": "1",
        "dx": "Essential hypertension",
        "RTServiceAuthorization": "AUTH9001502",
        "selfPay": "0",
        "deptId": "14",
        "resources": "247093",
        "ShowInsEligOnAppt": false,
        "userId": 100005,
        "eligibilityStatus": "Active",
        "POS": "11",
        "newPt": "0",
        "status": "Active"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}