- Create powerful apps with Jicoo's API
- Quick start
- Authentication
- Errors
- Versioning
- Types
- API Reference Overview
- Guide
- Guide(Japanese)
- API Reference
- Jicoo API
- Webhook Schema
- Booking
- Schedule
- Availability
- Oraganization
- Event Types
List Schedules
GET
/v1/schedules
This list does not include bookings made on the event type page.
The schedule is the same as the one created on the Jicoo calendar page below.
https://www.jicoo.com/dashboard/calendars
Request
Authorization
Add parameter in header
X-Jicoo-Api-Key
Example:
X-Jicoo-Api-Key: ********************
Query Params
page
number
optional
Example:
1
perPage
number
optional
Example:
20
Body Params application/json
object {0}
Example
{}
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/schedules?page=1&perPage=20' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw ''
Responses
🟢200Success
application/json
Body
data
array[object (Schedule) {25}]
required
uid
string
required
name
string
required
<= 64 characters
description
required
routine
required
isRemind
boolean
required
projectId
required
phoneNumber
required
access
required
address
required
customLocation
required
attendees
array [object {4}]
required
isAllDay
boolean
required
timeZone
string
required
startedAt
required
endedAt
required
priority
required
displayType
enum<string>
required
Allowed values:
privateteamPublicpublic
location
required
transparency
enum<string>
required
Allowed values:
opaquetransparent
behavior
enum<string>
required
Allowed values:
eventwork
visibilityType
enum<string>
required
Allowed values:
defaultbusy
status
enum<string>
required
Allowed values:
opencancel
url
string | null
required
updatedAt
string <date-time>
required
createdAt
string <date-time>
required
totalCount
integer
required
count
integer
required
currentPage
integer
required
nextPage
integer
optional
numberOfPages
integer
required
Example
{
"data": [
{
"uid": "occaecat dolore et",
"name": "dolores soluta iure",
"status": "cancel",
"startedAt": "2024-03-01T10:30:19.322Z",
"endedAt": "2024-03-01T09:25:03.445Z",
"address": "amet",
"url": "http://emotional-comptroller.name",
"phoneNumber": "1-532-936-2524",
"customLocation": null,
"description": "Animi sunt cupiditate ex quae dolor natus. Incidunt placeat optio consequuntur maxime. Velit beatae perferendis.",
"isRoutine": false,
"routine": null,
"isRemind": false,
"projectId": null,
"access": "sint ea",
"attendees": [
{
"userId": "qui id velit",
"email": "Lorenz_Erdman@yahoo.com",
"role": "in est",
"userType": "magna Duis"
}
],
"isAllDay": true,
"timeZone": "Pacific/Pago_Pago",
"priority": "middle",
"displayType": "private",
"location": "custom",
"transparency": "transparent",
"behavior": "event",
"visibilityType": "default",
"createdAt": "2024-03-01T05:48:39.000Z",
"updatedAt": "2024-03-01T05:48:39.000Z"
}
],
"totalCount": 2,
"count": 1,
"currentPage": 1,
"nextPage": 2,
"numberOfPages": 2
}
Modified at 2024-08-02 12:55:09