v1

latestOpenAPI 3.0.02026-07-17121287546.7 KB

Event Types

Get all event types

Hidden event types are returned only if authentication is provided and it belongs to the event type owner.

  Use the optional `sortCreatedAt` query parameter to order results by creation date (by ID). Accepts "asc" (oldest first) or "desc" (newest first). When not provided, no explicit ordering is applied.
  
  <Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>

get/v2/event-types

Query parameters

usernamestring

The username of the user to get event types for. If only username provided will get all event types.

eventSlugstring

Slug of event type to return. Notably, if eventSlug is provided then username must be provided too, because multiple users can have event with same slug.

usernamesstring

Get dynamic event type for multiple usernames separated by comma. e.g usernames=alice,bob

orgSlugstring

slug of the user's organization if he is in one, orgId is not required if using this parameter

orgIdnumber

ID of the organization of the user you want the get the event-types of, orgSlug is not needed when using this parameter

sortCreatedAt'asc' | 'desc'

Sort event types by creation date. When not provided, no explicit ordering is applied.

Headers

cal-api-versionstring required

Must be set to 2024-06-14. If not set to this value, the endpoint will default to an older version.

Authorizationstring

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

x-cal-secret-keystring

For platform customers - OAuth client secret key

x-cal-client-idstring

For platform customers - OAuth client ID

Response

status'success' | 'error' required

Example response

{
  "status": "success",
  "data": [
    {
      "id": 1,
      "lengthInMinutes": 60,
      "lengthInMinutesOptions": [
        15,
        30,
        60
      ],
      "title": "Learn the secrets of masterchief!",
      "slug": "learn-the-secrets-of-masterchief",
      "description": "Discover the culinary wonders of Argentina by making the best flan ever!",
      "locations": [
        {
          "type": "address",
          "address": "123 Example St, City, Country"
        }
      ],
      "bookingFields": [
        {
          "type": "name"
        }
      ],
      "recurrence": {
        "interval": 10,
        "occurrences": 10
      },
      "bookerActiveBookingsLimit": {
        "maximumActiveBookings": 3
      },
      "bookingWindow": [
        {
          "value": 5,
          "rolling": true
        }
      ],
      "color": {
        "lightThemeHex": "#292929",
        "darkThemeHex": "#fafafa"
      },
      "seats": {
        "seatsPerTimeSlot": 4,
        "showAttendeeInfo": true,
        "showAvailabilityCount": true
      },
      "disableCancelling": {
        "disabled": true
      },
      "disableRescheduling": {
        "disabled": true,
        "minutesBefore": 60
      },
      "ownerId": 10,
      "bookingUrl": "https://cal.com/john-doe/30min"
    }
  ]
}