Jicoo Developer Potal
  1. Availability
Jicoo Developer Potal
  • Create powerful apps with Jicoo's API
  • Quick start
  • Authentication
  • Errors
  • Versioning
  • Types
  • API Reference Overview
  • Guide
    • How to use webhook
    • How to use Account integration
  • Guide(Japanese)
    • アカウント連携の使い方
    • Webhookの使い方
    • ホストの優先度を更新する方法
  • API Reference
    • Jicoo API
    • Webhook Schema
      • Webhook schema
      • event property
      • createdAt property
      • object property
      • contact property
      • answers property
      • answers items property
      • tracking property
    • Booking
      • List Bookings
      • Get Booking
      • Cancel Booking
      • Reschedule Booking
      • Create Booking
      • Update Booking
      • Get Booking Contacts
    • Schedule
      • Update Schedule
      • Create Schedule
      • List Schedules
      • Delete Schedule
    • Availability
      • List User Availability Calendars
        GET
      • Get User Availability Calendar
        GET
    • Oraganization
      • User
        • List Organization Users
        • Delete Organization User
        • Get Organization User
        • Update Organization User
      • Invitation
        • Create Organiztion Invitation
        • List Organization Invitations
        • Get Organization Invitation
        • Delete Organiztion Invitation
      • Get Organization Team
    • Event Types
      • Get Event Type
      • List Event Types
      • List Event Type Hosts
      • Get Event Type Available Schedules
      • Account Integration
      • Update Event Type Host
      • Delete Event Type Host
      • Create Event Type Host
  1. Availability

List User Availability Calendars

GET
/v1/user_availability_calendars
The List User Availability Calendars API returns a list of templates that define user availability for accepting bookings. These templates are used to configure and manage the schedules during which bookings can be accepted. Each template provides a preset schedule that can be applied to different event types, streamlining the process of setting up availability across various booking scenarios.
https://www.jicoo.com/dashboard/event_types/settings

Request

Authorization
Add parameter in header
X-Jicoo-Api-Key
Example:
X-Jicoo-Api-Key: ********************
Query Params
userId
string 
required
page
number 
optional
perPage
number 
optional

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/user_availability_calendars?userId&page&perPage' \
--header 'X-Jicoo-Api-Key;'

Responses

🟢200Success
application/json
Body
data
array[object (UserAvailabilityCalendar) {8}] 
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
totalCount
integer 
required
total count
count
integer 
required
current count
currentPage
integer 
required
current page
nextPage
integer 
optional
next page
numberOfPages
integer 
required
number of pages
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": {},
  "totalCount": 1,
  "count": 1,
  "currentPage": 1,
  "numberOfPages": 1
}
Previous
Delete Schedule
Next
Get User Availability Calendar
Built with