Business Hours

List Business Hours

Retrieve a list of defined business hours, showcasing their names, and other information.

GET/workspaces/{workspaceId}/business-hours

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200404

ok

Body

application/json

results*array of BusinessHours (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "timezone": "text",
      "weeklySchedule": {
        "monday": {
          "from": {},
          "to": {}
        },
        "tuesday": {
          "from": {},
          "to": {}
        },
        "wednesday": {
          "from": {},
          "to": {}
        },
        "thursday": {
          "from": {},
          "to": {}
        },
        "friday": {
          "from": {},
          "to": {}
        },
        "saturday": {
          "from": {},
          "to": {}
        },
        "sunday": {
          "from": {},
          "to": {}
        }
      },
      "holidays": [
        {
          "name": "text"
        }
      ],
      "assignedTeamIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "2024-11-21T09:10:27.430Z",
      "updatedAt": "2024-11-21T09:10:27.430Z"
    }
  ]
}

Create Business Hours

Define and create new business hours, specifying the name, schedule.

POST/workspaces/{workspaceId}/business-hours

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

descriptionstring

timezone*string

weeklySchedule*WeeklySchedule (object)

holidays*nullable array of Holiday (object)

assignedTeamIdsnullable array of string (uuid)

Response

201404422

created

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "timezone": "text",
      "weeklySchedule": {},
      "holidays": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Get Business Hours

Retrieve information about specific business hours, including their name, schedule.

GET/workspaces/{workspaceId}/business-hours/{businessHourId}

Authorization

useraccessKey

Path parameters

workspaceId*string

businessHourId*string (uuid)

Business Hours entry UUID

Response

200404

ok

Body

application/json

id*string (uuid)

name*string

descriptionstring

timezone*string

weeklySchedule*WeeklySchedule (object)

holidays*array of Holiday (object)

assignedTeamIdsarray of string (uuid)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours/{businessHourId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timezone": "text",
  "weeklySchedule": {
    "monday": {
      "from": {},
      "to": {}
    },
    "tuesday": {
      "from": {},
      "to": {}
    },
    "wednesday": {
      "from": {},
      "to": {}
    },
    "thursday": {
      "from": {},
      "to": {}
    },
    "friday": {
      "from": {},
      "to": {}
    },
    "saturday": {
      "from": {},
      "to": {}
    },
    "sunday": {
      "from": {},
      "to": {}
    }
  },
  "holidays": [
    {
      "name": "text"
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2024-11-21T09:10:27.430Z",
  "updatedAt": "2024-11-21T09:10:27.430Z"
}

Update Business Hours

Modify the details of specific business hours, such as their name, schedule.

PATCH/workspaces/{workspaceId}/business-hours/{businessHourId}

Authorization

useraccessKey

Path parameters

workspaceId*string

businessHourId*string (uuid)

Business Hours entry UUID

Body

application/json

namestring

descriptionstring

timezonestring

weeklyScheduleWeeklySchedule (object)

holidaysnullable array of Holiday (object)

assignedTeamIdsnullable array of string (uuid)

Response

200404422

updated

Body

application/json

id*string (uuid)

name*string

descriptionstring

timezone*string

weeklySchedule*WeeklySchedule (object)

holidays*array of Holiday (object)

assignedTeamIdsarray of string (uuid)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours/{businessHourId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timezone": "text",
  "weeklySchedule": {
    "monday": {
      "from": {},
      "to": {}
    },
    "tuesday": {
      "from": {},
      "to": {}
    },
    "wednesday": {
      "from": {},
      "to": {}
    },
    "thursday": {
      "from": {},
      "to": {}
    },
    "friday": {
      "from": {},
      "to": {}
    },
    "saturday": {
      "from": {},
      "to": {}
    },
    "sunday": {
      "from": {},
      "to": {}
    }
  },
  "holidays": [
    {
      "name": "text"
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2024-11-21T09:10:27.430Z",
  "updatedAt": "2024-11-21T09:10:27.430Z"
}

Delete Business Hours

Remove specific business hours, permanently deleting their defined schedule.

DELETE/workspaces/{workspaceId}/business-hours/{businessHourId}

Authorization

useraccessKey

Path parameters

workspaceId*string

businessHourId*string (uuid)

Business Hours entry UUID

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours/{businessHourId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Check if current time is in business hours

Determine if the current time falls within the defined business hours, providing information on availability.

GET/workspaces/{workspaceId}/business-hours/{businessHourId}/check

Authorization

useraccessKey

Path parameters

workspaceId*string

businessHourId*string (uuid)

Business Hours entry UUID

Response

200404

ok

Body

application/json

isOpen*boolean

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/business-hours/{businessHourId}/check', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "isOpen": false
}