Tross
Demo dataBook a demo
ECLINICALWORKS

Fetch appointments

List appointments for a provider and date.

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-appointments
Request Fields
input.provider_name
string
required
Provider whose resource schedule to read.
Example
"Rivera, Alex"
input.date
string
required
Calendar day to retrieve, supplied in MM/DD/YYYY format.
Example
"01/15/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
encounters
array
The encounter or appointment rows this call returned.
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 as an ISO timestamp.
Example
"2026-01-15T09:00:00"
encounters[].end
string
When the appointment slot ends.
Example
"2026-01-15T09:30: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 --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-appointments \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"provider_name":"Rivera, Alex","date":"01/15/2026"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "provider_name": "Rivera, Alex",
    "date": "01/15/2026"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "encounters": []
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}