Get User Availability Calendar

The Get User Availability Calendar API retrieves the booking availability template specified by the uid. This template defines the schedule during which bookings can be accepted, allowing users to view or manage the availability settings for specific booking scenarios. This API is useful for accessing detailed information about a particular availability configuration.

Responses

🟢200Success

application/json

Body

data

object (UserAvailabilityCalendar)

required

uid

string

required

Unique ID of the user availability calendar

userId

string

required

userId created the availability calendar

name

string

required

Name of the availability calendar

isDefault

boolean

required

Is default availability calendar

timezone

string

required

Timezone of the availability calendar

calendars

array [object {10}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

errors

object

required

Example

{
  "data": {
    "uid": "12eWFJ58fDjD",
    "teamId": 39,
    "userId": "oDVmLILwPNPdenYge4dFiRkVA6G3",
    "name": "基本設定",
    "isDefault": 1,
    "timezone": "Asia/Tokyo",
    "createdAt": "2024-02-07T13:04:41.000Z",
    "updatedAt": "2024-02-07T13:04:41.000Z",
    "calendars": [
      {
        "startHour": 10,
        "startMinute": 0,
        "endHour": 19,
        "endMinute": 0,
        "startedAt": "2024-02-07T13:05:02.000Z",
        "endedAt": null,
        "wday": 1,
        "frequencyType": 2,
        "frequencyInterval": 1,
        "exceptions": null
      },
      {
        "startHour": 10,
        "startMinute": 0,
        "endHour": 19,
        "endMinute": 0,
        "startedAt": "2024-02-07T13:05:02.000Z",
        "endedAt": null,
        "wday": 2,
        "frequencyType": 2,
        "frequencyInterval": 1,
        "exceptions": null
      }
    ]
  },
  "errors": {}
}

Request

Request samples

Responses