Endpoints
This page describes the different API endpoints and its parameters.
Return a Tana Paste or JSON representation of your calendar
GET http://localhost:PORT/events.format
The default endpoint supports both JSON and Tana Paste output. Replace 'format' with either tana or json to get the desired results. Use the parameters to customize the output.
Path Parameters
format*
String
Either tana or json
Query Parameters
filterField
String
Filters specific fields from the output (comma separated)
filterTitle
String
Filters events with these titles (comma separated)
filterAttendee
String
Filters attendees with these names (comma separated)
filterStatus
String
Filters events with these statuses (comma separated) Options: Canceled, Confirmed, None, Tentative, Unknown
filterCalendar
String
Filters events from these calendars (comma separated)
tag
String
Customize the tag (default: meeting)
date
String
Specify a specific date (default is today). Format: YYYY-MM-DDD
offset
Integer
How many days to return events for (default is 1).
truncate
Bool
Truncate the notes field to remove content from video calls
filterAvailability
String
Filters events with these availabilities (comma separated) Options: Free, Busy, Not Supported, Tentative, Unavailable, Unknown
selectCalendar
String
Select events from these calendars (comma separated)
filterAllDay
Bool
Filters events that are all day or not all day Options: true, false
*-tag
String
One or more url-encoded regexes (split by __) that when successfully matched against the event title, use the specified tag. i.e 1-1-tag=.%2A%20-%20.%2A__Sync%24
timingField
String
Customize the name of the timing field (default: Timing)
Headers
Authorization*
String
Bearer token
Fill a custom template with your calendar information
POST http://localhost:PORT/events
Post an event template and the API will return it filled for each event. You can use the variables named under 'Body' in your template.
Example:
- {Title} ({Start} - {End})
Query Parameters
filterTitle
String
Filters events with these titles (comma separated)
filterAttendee
String
Filters attendees with these names (comma separated)
filterStatus
String
Filters events with these statuses (comma separated) Options: Canceled, Confirmed, None, Tentative, Unknown
filterCalendar
String
Filters events from these calendars (comma separated)
tag
String
Customize the tag (default: meeting)
date
String
Specify a specific date (default is today). Format: YYYY-MM-DDD
offset
Integer
How many days to return events for (default is 1).
truncate
Bool
Truncate the notes field to remove content from video calls
filterAvailability
String
Filters events with these availabilities (comma separated) Options: Free, Busy, Not Supported, Tentative, Unavailable, Unknown
selectCalendar
String
Select events from these calendars (comma separated)
filterAllDay
Bool
Filters events that are all day or not all day Options: true, false
*-tag
String
One or more url-encoded regexes (split by __) that when successfully matched against the event title, use the specified tag. i.e 1-1-tag=.%2A%20-%20.%2A__Sync%24
Headers
Authorization*
String
Bearer token
Request Body
{Title}
String
Title of the event
{Location}
String
Location of the event
{Status}
String
Status of the event
{Attendee}
String
Attendee of the event (the line will be multiplied per attendee)
{Start}
String
Start datetime of the event
{End}
String
End datetime of the event
{Notes}
String
The notes of the event
{Tag}
String
The matched tag from the *-tag attributes in the query, defaults to 'meeting'
Create events
POST http://localhost:PORT/events/create
Create event in the default (or specfied calendar) from the posted JSON body.
Example:
{ "title": "${name}", "startDate": "${Timing.start}", "endDate": "${Timing.end}", "notes": "${Notes}"}
Query Parameters
calendar
String
Name of the calendar to add the event to
Headers
Authorization*
String
Bearer token
Last updated