v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Working Hours

View working hour labels

This endpoint returns a list of Working Hour Labels, narrowed down by the optional filters configured.

get/working_hour_labels

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger

Id of the associated location. Returns labels tied to the location as well as institution-wide labels available to it

search_namestring

Filter working hour labels by search term

activeboolean

Filter by active status.

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.

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": 113,
      "location_id": 115,
      "name": "New patient appointments"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}