Jicoo Developer Potal
  1. API Reference
  2. Event Types
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 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
        GET
      • List Event Types
        GET
      • List Event Type Hosts
        GET
      • Get Event Type Available Schedules
        GET
      • Account Integration
        POST
      • Update Event Type Host
        PATCH
      • Delete Event Type Host
        DELETE
      • Create Event Type Host
        POST
  1. API Reference
  2. Event Types

Get Event Type

GET
/v1/event_types/{uid}
The Get Event Type API retrieves detailed information about a specific EventType, identified by uid. This API provides a comprehensive view of the event type’s settings, availability, and associated options.

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

Responses

🟢200Success
application/json
Body
data
object (EventType) 
required
uid
string 
required
Unique identifier of the event type
slug
string 
required
Slug of the event type
name
string 
required
Name of the event type
description
string  | null 
required
Description of the event type
coverImage
string  | null 
required
Cover image of the event type
color
string 
required
Color of the event type
duration
integer 
required
Duration of the event type
> 0
status
enum<string> 
required
Status of the event type available
Allowed values:
enabledisable
internalNote
string  | null 
required
Internal note of the event type
locations
array [object {1}] 
required
questions
array [object {6}] 
required
services
array [object {8}] 
required
paymentMethods
array [object {1}] 
required
createdAt
string <date-time>
required
Created date of the event type
updatedAt
string <date-time>
required
Updated date of the event type
Example
{
  "data": {
    "uid": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "coverImage": "string",
    "color": "string",
    "duration": 1,
    "status": "enable",
    "internalNote": "string",
    "locations": [
      {
        "locationId": "inPerson"
      }
    ],
    "questions": [
      {
        "uid": "string",
        "choices": [
          {
            "uid": "string",
            "value": "string"
          }
        ],
        "content": "string",
        "isRequired": true,
        "workflowType": "text",
        "hasOtherChoice": true
      }
    ],
    "services": [
      {
        "id": 0,
        "name": "string",
        "description": "string",
        "coverImage": "string",
        "isRequired": true,
        "isShowPrice": true,
        "price": {
          "currency": "jpy",
          "unitAmount": 0,
          "taxInclusive": "exclusive",
          "taxPercentage": 0
        },
        "sort": 0
      }
    ],
    "paymentMethods": [
      {
        "methodType": "none"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Modified at 2024-08-28 11:50:33
Previous
Get Organization Team
Next
List Event Types
Built with