---
title: "Get a business hours schedule definition."
method: GET
path: "/beta/business-hours/schedules/{scheduleId}/definition"
tags: ["Business Hours"]
---

# Get a business hours schedule definition.

`GET /beta/business-hours/schedules/{scheduleId}/definition`

## Request

- Base URL: `https://dev.dixa.io`
- URL: `https://dev.dixa.io/beta/business-hours/schedules/{scheduleId}/definition`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dixa/apis/dixa-api/docs/beta/business-hours/schedules/:scheduleId/definition/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a business hours schedule definition in an organization by providing its ID.

## Path parameters

- `scheduleId` string, uuid, required

## Response `200`

- GetBusinessHoursScheduleDefinitionOutput
  - `data` GetBusinessHoursScheduleDefinitionResult, required
    - `schedule` BusinessHoursScheduleDefinition, required
      - `id` string, required
      - `name` string, required
      - `timezone` string, required
      - `businessHours` BusinessHourRegular[]
        - `name` string, required
        - `dayOfWeek` integer
        - `businessHourType` BusinessHourRegularType, required
        - `status` union, required
          - Closed
          - Open
        - `intervals` TimeInterval[]
          - `startTime` string, required
          - `endTime` string, required
        - `startDate` string, required
      - `exceptions` BusinessHourException[]
        - `name` string, required
        - `businessHourType` union, required
          - Exception
          - Holiday
        - `status` union, required
          - Closed
          - Open
        - `intervals` TimeInterval[]
          - `startTime` string, required
          - `endTime` string, required
        - `recurring` Recurring
          - `dayOfMonth` integer
          - `monthOfYear` integer
          - `holiday` string
        - `startDate` string, required
        - `nextDate` string

## Other responses

- `400`: Invalid value for: path parameter scheduleId, Invalid value extracted from request context
- `404`: An entity in this request could not be found
- `500`: Internal failure during request processing

---

[API](https://skmtc.dev/dixa/apis/dixa-api.md) - [All operations](https://skmtc.dev/dixa/apis/dixa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dixa/apis/dixa-api/revisions/4c9e4ef864d1?raw)