Business Hours

List Business Hours

get

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

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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
          }
        }
      },
      "holidays": [
        {
          "name": "text",
          "day": 1,
          "month": 1
        }
      ],
      "assignedTeamIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "2025-03-28T18:48:45.677Z",
      "updatedAt": "2025-03-28T18:48:45.677Z"
    }
  ]
}

ok

Create Business Hours

post

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

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestringrequired

descriptionstringoptional

timezonestring · min: 1required

weeklyScheduleobjectrequired

holidaysobject[] | nullablerequired

assignedTeamIdsstring · uuid[] | nullableoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/business-hours' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
        }
      }
    },
    "holidays": [
      {
        "name": "text",
        "day": 1,
        "month": 1
      }
    ],
    "assignedTeamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

201

404

422

201

No body

created

Get Business Hours

get

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2025-03-28T18:48:45.677Z",
  "updatedAt": "2025-03-28T18:48:45.677Z"
}

ok

Update Business Hours

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Body

namestringoptional

descriptionstringoptional

timezonestring · min: 1optional

weeklyScheduleobjectoptional

holidaysobject[] | nullableoptional

assignedTeamIdsstring · uuid[] | nullableoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/business-hours/{businessHourId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
        }
      }
    },
    "holidays": [
      {
        "name": "text",
        "day": 1,
        "month": 1
      }
    ],
    "assignedTeamIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

404

422

200

{
  "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
      }
    }
  },
  "holidays": [
    {
      "name": "text",
      "day": 1,
      "month": 1
    }
  ],
  "assignedTeamIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "2025-03-28T18:48:45.677Z",
  "updatedAt": "2025-03-28T18:48:45.677Z"
}

updated

Delete Business Hours

delete

Remove specific business hours, permanently deleting their defined schedule.

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

204

404

204

No body

Deleted

Check if current time is in business hours

get

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

Authorizations

Path parameters

workspaceIdstringrequired

businessHourIdstring · uuidrequired

Business Hours entry UUID

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "isOpen": true
}

ok