v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Working Hours

View working hours

This endpoint returns the working hours for the specified location, narrowed down by the optional filters configured.

get/working_hours

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

provider_idinteger

Filter for specific provider

operatory_idinteger

Filter for specific operatory

label_idinteger

Filter by specific label

source'manual' | 'synced'

Filter by source of working hour

activeboolean

Filter active/not active

ignore_past_datesboolean

Filter out working hours configured for specific dates in the past

include[]string[]

Resources to be included in the response

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 12,
      "provider_id": 7,
      "location_id": 3,
      "operatory_id": 149,
      "begin_time": "10:30",
      "end_time": "17:00",
      "days": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ],
      "specific_date": "2022-11-03",
      "custom_recurrence": {
        "num": 3,
        "unit": "day",
        "ref": "2022-11-03"
      },
      "tz_offset": "-0700",
      "active": true,
      "source": "synced",
      "label": {
        "id": 113,
        "location_id": 115,
        "name": "New patient appointments"
      },
      "appointment_types": [
        {
          "id": 1,
          "name": "Medical",
          "parent_type": "Institution",
          "parent_id": 1,
          "minutes": 15
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}