Tross
ECLINICALWORKS

Search Available Slots

Search available slots in eClinicalWorks

POSThttps://api.ontross.com/api/integrations/ecw/search-available-slots
Request Fields
input
object
required
Read availability for one provider/resource and configured visit type.
input.facility_id
integer
required
Facility id
input.provider_id
integer
required
Provider or scheduling resource ID
input.provider_name
string
required
Provider name
input.visit_type
string
required
Visit type
input.start_date
string
required
Start date
input.start_time
string
Start time
input.end_time
string
End time
input.days
array
List of days.
Accepted values
sunmontuewedthufrisat
input.schedule_interval_minutes
integer
Scheduling grid interval (nSchDuration); the provider/visit type determines visit duration
Default
15
input.result_size
integer
Result size
Default
100
input.respect_visit_type_rules
boolean
Respect visit type rules
Default
true
auth_id
string
required
Auth id
Output Fields
slots
array
List of slots.
slots[].date
string
Date
slots[].datetime
string
ECW display date/time string, without timezone conversion
slots[].startTime
string
Start time
slots[].slotduration
integer
Slotduration
slots[].providerId
integer
Provider id
slots[].providerName
string
Provider name
slots[].providerNameAndId
string
Provider name and id
slots[].bookProviderId
integer
Book provider id
slots[].facilityId
integer
Facility id
slots[].facilityName
string
Facility name
slots[].facilityTimeZone
string
Facility time zone
slots[].facilitytimezoneTime
string
Facilitytimezone time
slots[].resourceTimeZone
string
Resource time zone
slots[].userType
integer
User type
slots[].visitType
string
Visit type
slots[].duration
string
Duration
result_count
integer
Result count
visit_duration_minutes
integer
Visit duration minutes
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/search-available-slots \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"facility_id":1,"provider_id":1,"provider_name":"string","visit_type":"string","start_date":"2026-01-01","start_time":"09:00:00Z","end_time":"09:00:00Z","days":[],"schedule_interval_minutes":1,"result_size":1,"respect_visit_type_rules":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "facility_id": 1,
    "provider_id": 1,
    "provider_name": "string",
    "visit_type": "string",
    "start_date": "2026-01-01",
    "start_time": "09:00:00Z",
    "end_time": "09:00:00Z",
    "days": [],
    "schedule_interval_minutes": 1,
    "result_size": 1,
    "respect_visit_type_rules": false
  },
  "auth_id": "auth_uuid_here"
}