Search calendars

get https://api.addevent.com/calevent/v2/calendars

Search for calendars you've previously created. Returns a search result object that contains a calendar property that contains an array of up to page_size calendars. If no calendars match the query, the resulting array will be empty.

Responses

Response body

object

pagination

object

Meta data about the search results and paging.

current_page

integer

Page number of the current page of search results.

next_page

integer

Page number of the next page of search results.

previous_page

integer

Page number of the previous page of search results.

total_items

integer

The total number of objects in the search results.

total_pages

integer

The total number of pages of search results.

page_size

integer

The number of search results per page

links

object

Links to additional search results.

next_page_url

string

Link to the next page of search results.

previous_page_url

string

Link to the previous page of search results.

calendars

array of objects

calendars

object

string

Unique identifier for the calendar.

unique_key

string

A public identifier for the calendar that is used for sharing the calendar.

title

string

The calendar's title.

timezone

string

The default timezone for events on the calendar.

weekday_begin

string

Day of the week that the calendar begins on. Values are sunday or monday.

is_default_calendar

boolean

Whether the calendar is the default calendar on the account.

description

string

The calendar's description. This appears on the calendar landing page.

internal_name

string

An internal name for the calendar. This will not be displayed publicly.

calendar_color

integer

The color of the calendar which appears in the dashboard. Values are between 1 and 20 and correspond to the colors on the calendar's palette.

palette_id

string

The ID of the custom color palette that is associated with the calendar. The value default indicates that the standard AddEvent palette is being used.

landing_page_template_id

string

The ID of the custom calendar landing page template that is associated with the calendar. The value default indicates that the standard AddEvent template is being used.

embeddable_calendar_template_id

string

The ID of the custom embeddable calendar template that is associated with the calendar. The value default indicates that the standard AddEvent template is being used.

stats

object

custom_data

object

Arbitary key-value pairs that can be attached to a calendar. Useful for storing additional structured data on an object, for example, storing external IDs to link a calendar to another system or linking to custom images for each calendar.

Has additional fields

link_long

string

The public URL to the calendar landing page. Used for sharing the calendar.

link_short

string

The public short URL to the calendar landing page. Used for sharing the calendar.

created

string

Time at which the calendar was created.

modified

string

Time at which the calendar was last updated.

Language

Credentials

Bearer

APIkey


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.addevent.com/calevent/v2/calendars \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad request