---
title: "View working hour labels (beta)"
method: GET
path: "/working_hour_labels"
tags: ["Working Hours"]
---

# View working hour labels (beta)

`GET /working_hour_labels`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/working_hour_labels`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

> **Changed from v3.0.0:** Adds response fields `data[].active`, `data[].color_hex`, `data[].default_duration_minutes`.

This endpoint returns working hour labels. Every filter is optional.

## Query parameters

- `subdomain` string, required
- `location_id` integer
- `search_name` string
- `active` boolean
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesWorkingHourLabelCollectionResponseWithCursor: API_V31_Entities_WorkingHourLabel_Collection_Response_WithCursor model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesWorkingHourLabel[]
    - `id` integer: Resource ID
    - `location_id` integer, nullable: The location ID
    - `name` string: The name for working hour label
    - `color_hex` string, nullable: The color of the working hour label as a hex code
    - `default_duration_minutes` integer, nullable: Slot length in minutes applied to working hours that inherit this label when no restriction row sets one
    - `active` boolean: False when the working hour label has been deactivated
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)