Jicoo Developer Potal
  1. Booking
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
      • Get Booking
        GET
      • Cancel Booking
        POST
      • Reschedule Booking
        POST
      • Create Booking
        POST
      • Update Booking
        PATCH
      • Get Booking Contacts
        GET
    • Schedule
      • Update Schedule
      • Create Schedule
      • List Schedules
      • Delete Schedule
    • Availability
      • List User Availability Calendars
      • Get User Availability Calendar
    • 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. Booking

Get Booking

GET
/v1/bookings/{uid}
The Get Booking API fetches detailed information about a specific booking identified by the uid. This endpoint provides comprehensive details, including the booking status, contact information, services booked, and any additional informations made during the booking.

Request

Authorization
Add parameter in header
X-Jicoo-Api-Key
Example:
X-Jicoo-Api-Key: ********************
Path Params
uid
string 
required

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/bookings/' \
--header 'X-Jicoo-Api-Key;'

Responses

🟢200Success
application/json
Body
data
object (Booking) 
required
uid
string 
required
Unique identifier for this booking
eventTypeId
string  | null 
required
EventTypeId associated with this event
name
string 
required
Booking name
description
string  | null 
required
Booking description
status
enum<string> 
required
Booking status
Allowed values:
requestopencancel
startedAt
string <date-time>
required
The time that event was scheduled to start in UTC time (e.g. "2024-03-01T20:00:00.000Z").
endedAt
string <date-time>
required
The time that event was scheduled to end in UTC time (e.g. "2024-03-01T21:00:00.000Z").
locationId
required
Location type. like zoom, google meet, etc.
url
string  | null 
required
online meeting url
phoneNumber
string  | null 
required
phone number
address
string  | null 
required
location address
customLocation
string  | null 
required
custom location name
access
string  | null 
required
access information
timeZone
string 
required
guest selected Timezone
priority
required
Booking priority
cancelReason
string  | null 
required
Booking cancel reason
cancelledAt
required
Booking cancelled time
cancelledBy
required
Booking canceller
hosts
array [object {2}] 
required
createdAt
string <date-time>
required
The time this booking was created
updatedAt
string <date-time>
required
The time this booking was updated
errors
object 
required
Example
{
  "data": {
    "uid": "string",
    "eventTypeId": "string",
    "name": "string",
    "description": "string",
    "status": "request",
    "startedAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "locationId": "inPerson",
    "url": "string",
    "phoneNumber": "string",
    "address": "string",
    "customLocation": "string",
    "access": "string",
    "timeZone": "string",
    "priority": "low",
    "cancelReason": "string",
    "cancelledAt": "2019-08-24T14:15:22Z",
    "cancelledBy": "host",
    "hosts": [
      {
        "userId": "string",
        "role": "admin"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "errors": {}
}
Modified at 2024-08-28 09:20:10
Previous
List Bookings
Next
Cancel Booking
Built with