Skip to content

List Event types

Endpoint

http
GET /unified/calendar/event_types
Integrations supported
  • Calendly

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
user
object

The user to filter the event types. Defaults to the authenticated user.

Supported in
  • Calendly
id
string

Unique identifier of the user.

status
string

Status of the Event Type

All possible enum values:
  • active
  • archived
  • inactive
Enum support by integration
  • Calendly
    • active
    • inactive
Supported in
  • Calendly
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • label
  • position
  • updated_at
Supported in
  • Calendly

Response Body

result
object[]

List of Event types

id
string
REQUIRED · 

Unique identifier of the Event Type

Supported in
  • Calendly
name
string

Slug or unique readable name of the Event Type

Supported in
  • Calendly
label
string

Human readable name of the Event Type

Supported in
  • Calendly
status
string

Status of the Event Type

All possible enum values:
  • active
  • archived
Supported in
  • Calendly
urls
object[]

URLs associated with the Event Type

Supported in
  • Calendly
url
string
type
string

The type of the URL

All possible enum values:
  • scheduling
color
string

The color associated with this Event Type

Supported in
  • Calendly
duration
number

The length of the Event scheduled using this Event Type in minutes

Supported in
  • Calendly
description
string

The description of the Event Type

Supported in
  • Calendly
allow_scheduling
boolean

Whether scheduling an Event is allowed using this Event Type

Supported in
  • Calendly
position
number

The position of the Event Type on a listing page

Supported in
  • Calendly
form_fields
object[]

Form fields associated with the Event Type

Supported in
  • Calendly
label
string

Label used for the field

type
string

The type of the form field

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
is_enabled
boolean

Is the form field enabled?

is_required
boolean

Is the form field required to be answered?

position
number

Order of the field in the form

options
object[]

The choices to be selected in case of multi-choice fields

label
string

Human readable name for the choice

value
string

The value for the choice

locations
object[]

The location choices associated with the Event Type

Supported in
  • Calendly
id
string

The unique identifier of the location.

name
string

The name of the location.

address
object
street_1
string

The first line of the street address.

street_2
string

The second line of the street address.

city
string

The city of the address.

state
string

The state of the address.

country
string

The country of the address.

postal_code
string

The postal code of the address.

url
string

The URL of the location.

coordinates
object
latitude
number

The latitude of the location.

longitude
number

The longitude of the location.

created_at
string · date-time

The date and time at which this Event Type was created

Supported in
  • Calendly
updated_at
string · date-time

The date and time at which this Event Type was last modified

Supported in
  • Calendly
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.