Business Hours

Last updated 5 months ago

Was this helpful?

List Business Hours

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

get

/workspaces/{workspaceId}/business-hours

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/business-hours' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "timezone": "text",
      "weeklySchedule": {
        "monday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "tuesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "wednesday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "thursday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "friday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "saturday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        },
        "sunday": {
          "from": {
            "hour": 1,
            "minute": 1
          },
          "to": {
            "hour": 1,
            "minute": 1
          }
        }
      },
      "createdAt": "2025-02-21T18:10:48.165Z",
      "updatedAt": "2025-02-21T18:10:48.165Z",
      "holidays": [
        {
          "name": "text",
          "day": 1,
          "month": 1
        }
      ],
      "assignedTeamIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Create Business Hours

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

post

/workspaces/{workspaceId}/business-hours

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

descriptionstring

timezonestring · min: 1required

weeklyScheduleobjectrequired

holidaysobject[] | nullablerequired

assignedTeamIdsstring · uuid[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/business-hours' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","timezone":"text","weeklySchedule":{"monday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"tuesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"wednesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"thursday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"friday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"saturday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"sunday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}}},"holidays":[{"name":"text","day":1,"month":1}],"assignedTeamIds":[null]}'

201

404

422

No body

created

Get Business Hours

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

get

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timezone": "text",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "createdAt": "2025-02-21T18:10:48.165Z",
  "updatedAt": "2025-02-21T18:10:48.165Z",
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Update Business Hours

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

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Body

namestring

descriptionstring

timezonestring · min: 1

weeklyScheduleobject

holidaysobject[] | nullable

assignedTeamIdsstring · uuid[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"weeklySchedule":{"monday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"tuesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"wednesday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"thursday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"friday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"saturday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}},"sunday":{"from":{"hour":1,"minute":1},"to":{"hour":1,"minute":1}}},"holidays":[{"name":"text","day":1,"month":1}],"assignedTeamIds":[null]}'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "timezone": "text",
  "weeklySchedule": {
    "monday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "tuesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "wednesday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "thursday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "friday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "saturday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    },
    "sunday": {
      "from": {
        "hour": 1,
        "minute": 1
      },
      "to": {
        "hour": 1,
        "minute": 1
      }
    }
  },
  "createdAt": "2025-02-21T18:10:48.165Z",
  "updatedAt": "2025-02-21T18:10:48.165Z",
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

updated

Delete Business Hours

Remove specific business hours, permanently deleting their defined schedule.

delete

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Deleted

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/business-hours/{businessHourId}/check' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "isOpen": true
}