List all calendar events

get

https://api.unipile.com/v2/{account_id}/calendars/{calendar_id}/events

Returns a list of calendar events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

calendar_id

string

required

length ≥ 1

Identifier of the calendar.

account_id

string

required

^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Query Params

is_cancelled

boolean

Defaults to true

Whether you want to retrieve the cancelled events.

title

string

Filter for events matching the specified title.

description

string

Filter for events matching the specified description.

ical_uid

string

Filter for events matching the specified iCal UID.

location

string

Filter for events matching the specified location.

start

string

Filter events starting after this date.

end

string

Filter events ending before this date.

busy

boolean

Filter for events with the status busy

updated_before

string

Filter events updated before this date.

updated_after

string

Filter events updated after this date.

attendees

string

Filter events with attendees contained in this list. This parameter accepts a comma-delimited list of email addresses.

event_type

string

Filter events by event type. This parameter accepts a comma-delimited list of event type.

expand_recurring

boolean

Filter events by type (single or occurence).

offset

number

An offset used for pagination, if supported by the provider, else use cursor.

cursor

string

A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.

limit

number

≥ 1

Defaults to 20

The limit of items to be returned. The maximum allowed value depends on the provider.

Response

Language

Credentials

Header

Loading…

Response

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

application/json

200Default Response