List Event Types

The List Event Types API retrieves a list of all event types available within the system. This API provides detailed information about each event type, including its settings, availability, associated services, and payment methods. It is useful for managing and reviewing all EventTypes configured within the system.

Responses

🟢200Success

application/json

Body

data

array[object (EventType) {15}]

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

totalCount

integer

required

total count

count

integer

required

current count

currentPage

integer

required

current page

integer

optional

numberOfPages

integer

required

number of pages

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"
    }
  ],
  "totalCount": 0,
  "count": 0,
  "currentPage": 0,
  "nextPage": 0,
  "numberOfPages": 0
}

Request

Request samples

Responses