Business Hours

List Business Hours

get

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

Authorizations

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

application/json

404

Workspace not found

application/json

get

/workspaces/{workspaceId}/business-hours

GET /workspaces/{workspaceId}/business-hours HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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-11-27T03:25:07.541Z",
      "updatedAt": "2025-11-27T03:25:07.541Z",
      "currentStatus": "open",
      "nextOpenTime": "2025-11-27T03:25:07.541Z",
      "nextCloseTime": "2025-11-27T03:25:07.541Z"
    }
  ]
}

Create Business Hours

post

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

Authorizations

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Body

namestringRequired

descriptionstringOptional

timezonestring · min: 1Required

assignedTeamIdsstring · uuid[] | nullableOptional

Responses

201

created

404

Workspace not found

application/json

422

Invalid request

application/json

post

/workspaces/{workspaceId}/business-hours

POST /workspaces/{workspaceId}/business-hours HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "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"
  ]
}

No content

Get Business Hours

get

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

Authorizations

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

businessHourIdstring · uuidRequired

Business Hours entry UUID

Responses

200

application/json

404

Workspace or user not found

application/json

get

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

GET /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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-11-27T03:25:07.541Z",
  "updatedAt": "2025-11-27T03:25:07.541Z",
  "currentStatus": "open",
  "nextOpenTime": "2025-11-27T03:25:07.541Z",
  "nextCloseTime": "2025-11-27T03:25:07.541Z"
}

Update Business Hours

patch

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

Authorizations

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

businessHourIdstring · uuidRequired

Business Hours entry UUID

Body

namestringOptional

descriptionstringOptional

timezonestring · min: 1Optional

assignedTeamIdsstring · uuid[] | nullableOptional

Responses

200

updated

application/json

404

Workspace not found

application/json

422

Invalid request

application/json

patch

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

PATCH /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "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"
  ]
}

{
  "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-11-27T03:25:07.541Z",
  "updatedAt": "2025-11-27T03:25:07.541Z",
  "currentStatus": "open",
  "nextOpenTime": "2025-11-27T03:25:07.541Z",
  "nextCloseTime": "2025-11-27T03:25:07.541Z"
}

Delete Business Hours

delete

Remove specific business hours, permanently deleting their defined schedule.

Authorizations

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

businessHourIdstring · uuidRequired

Business Hours entry UUID

Responses

204

Deleted

404

Business Hours or workspace not found

application/json

delete

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

DELETE /workspaces/{workspaceId}/business-hours/{businessHourId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

businessHourIdstring · uuidRequired

Business Hours entry UUID

Responses

200

application/json

404

Workspace, user or business hours not found

application/json

get

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

GET /workspaces/{workspaceId}/business-hours/{businessHourId}/check HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "isOpen": true
}

Last updated 3 months ago

Was this helpful?