Athena Search appointment availability

POSThttps://preview.ontross.com/api/integrations/athena/search-appointment-availability

input.org_id

integer

required

Athena practice ID; also the scheduling context id.

Example

32817

input.department_id

integer

required

Runtime Athena context department.

Example

1

input.schedule_ids

array

required

Scheduling resource IDs (provider/department schedules), e.g. '32817-4-10'.

input.start_date

string

required

First day of the availability window (YYYY-MM-DD).

Example

"2026-12-01"

input.end_date

string

required

Last day of the availability window (YYYY-MM-DD).

Example

"2027-01-09"

input.exact_match

boolean

Restrict to slots exactly matching the requested type.

Example

false

Default

false

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"

days

array

Daily availability summaries for the requested scheduling resources.

days[].date

string

Calendar day the availability applies to.

Example

"2026-12-01"

days[].schedules

array

Resource availability summaries for the reported calendar day.

days[].schedules[].schedule_id

string

Scheduling resource ID the slots belong to.

Example

"68421-4-10"

days[].schedules[].appointment_types

array

Appointment type IDs bookable in the open slots.

days[].schedules[].is_fully_booked

boolean

True when the resource has no open slot that day.

Example

false

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/search-appointment-availability \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":1,"end_date":"2027-01-09","exact_match":false,"org_id":32817,"schedule_ids":["32817-4-10"],"start_date":"2026-12-01"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "department_id": 1,
    "end_date": "2027-01-09",
    "exact_match": false,
    "org_id": 32817,
    "schedule_ids": [
      "32817-4-10"
    ],
    "start_date": "2026-12-01"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "days": [
      {
        "date": "2026-12-01",
        "schedules": [
          {
            "schedule_id": "68421-4-10",
            "appointment_types": [
              "string"
            ],
            "is_fully_booked": false
          }
        ]
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}