Tn Fetch schedule

POSThttps://preview.ontross.com/api/integrations/tn/fetch-schedule

input.date

string

required

Calendar day whose entries are returned, midnight America/Los_Angeles time.

Example

"03/09/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"

CalendarItems

array

Every calendar entry on the date you requested.

CalendarItems[].ID

integer

Numeric id of the clinician, or of the calendar entry on schedules.

Example

765432109

CalendarItems[].PracticeID

integer

The TherapyNotes practice owning this calendar entry.

Example

876543210

CalendarItems[].HasMultiplePatientTimeZones

boolean

True when the booked patients sit in different time zones.

Example

false

CalendarItems[].TimeZoneAbbreviation

string

Short zone label for the practice's own times.

Example

"PST"

CalendarItems[].PatientTimeZoneAbbreviation

string

Short zone label for the patient's local times.

Example

"EST"

CalendarItems[].PatientStartDate

string

Appointment start rendered in the patient's time zone.

Example

"2026-01-20T12:00:00"

CalendarItems[].PatientEndDate

string

Appointment end rendered in the patient's time zone.

Example

"2026-01-20T13:00:00"

CalendarItems[].Type

integer

Coded kind of calendar entry, such as appointment or block.

Example

1

CalendarItems[].TypeName

string

Readable kind of calendar entry.

Example

"Appointment"

CalendarItems[].Status

integer

Coded state of the patient, appointment, or insurance provider returned.

Example

1

CalendarItems[].StartDate

string

Appointment start in the practice's local time.

Example

"2026-01-20T09:00:00"

CalendarItems[].StartDateUtc

string

That same appointment start expressed in UTC.

Example

"2026-01-20T17:00:00Z"

CalendarItems[].EndDate

string

Appointment end in the practice's local time.

Example

"2026-01-20T10:00:00"

CalendarItems[].EndDateUtc

string

That same appointment end expressed in UTC.

Example

"2026-01-20T18:00:00Z"

CalendarItems[].RecurringType

integer

Coded repeat pattern, zero for one off entries.

Example

0

CalendarItems[].RecurringRule

integer

Numeric repeat rule backing the recurrence series.

Example

0

CalendarItems[].IsPracticeWide

boolean

True for entries that block the whole practice calendar.

Example

false

CalendarItems[].Patients

array

Patients on this entry, carrying only their numeric ids.

CalendarItems[].Patients[].ID

integer

Numeric id of the clinician, or of the calendar entry on schedules.

Example

987654321

CalendarItems[].CalendarEntryPatients

array

Patient to appointment links, with practice and entry ids.

CalendarItems[].CalendarEntryPatients[].PatientId

integer

Numeric TherapyNotes id for the patient on this record.

Example

987654321

CalendarItems[].CalendarEntryPatients[].PracticeID

integer

The TherapyNotes practice owning this calendar entry.

Example

876543210

CalendarItems[].CalendarEntryPatients[].CalendarEntryID

integer

The calendar entry this billing row or patient link points to.

Example

765432109

CalendarItems[].RecurrenceSelectedDaysOfWeek

integer

Bit coded weekdays the recurring series lands on.

Example

0

CalendarItems[].NextAppointmentID

integer

The next entry in this recurring series.

Example

765432110

CalendarItems[].SeriesNextDate

string

Date of that next occurrence in the series.

Example

"2026-01-27T09:00:00"

CalendarItems[].AppointmentMode

string

Readable delivery mode such as in person or telehealth.

Example

"Telehealth"

CalendarItems[].ServiceCodeID

integer

TherapyNotes record for the service code billed or scheduled.

Example

654321098

CalendarItems[].LocationType

integer

Coded office or telehealth location for the appointment.

Example

1

CalendarItems[].CustomLocation

integer

Numeric id of a practice defined location, not its name.

Example

543210987

CalendarItems[].ClinicianID

integer

Clinician who delivered or is booked for this appointment.

Example

432109876

CalendarItems[].EncryptedID

string

Obfuscated clinician or calendar entry id used in portal URLs.

Example

"Q7m2V9x4K8p3R6t1W5y0ZA"

CalendarItems[].IsTelehealth

boolean

True when the appointment is held over video.

Example

true

CalendarItems[].Note

string

Free text note staff attached to the calendar entry.

Example

"Use the video link for this appointment."

curl --request POST \
  --url https://preview.ontross.com/api/integrations/tn/fetch-schedule \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"date":"03/09/2026"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "date": "03/09/2026"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "CalendarItems": []
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}