Using API v1? See what changes in v2, or the v1 docs
API reference
Every endpoint of the Pyas API v2, generated from its OpenAPI document. Send requests to https://api.pyas.io with your API key in the x-api-key header.
Accounts
List connected calendar accounts and manage their status, settings and imports, including virtual accounts.
- GETList accounts
- POSTCreate a virtual account
- GETGet an account
- PATCHUpdate an account
- DELETEDelete an account
- POSTImport accounts
- GETList account imports
- GETGet the status of several accounts
- GETGet calendar settings
- PATCHUpdate calendar settings
- GETGet the status of an account
- GETList working locations
- GETGet an account import
- POSTRetry an account import
Connect
Connect and reconnect calendar accounts with connect sessions, including the steps that run in the user's browser.
Calendars
Manage calendars, calendar sharing, categories, feeds and calendar groups.
- GETList calendar groups
- POSTCreate a calendar group
- GETList calendars
- POSTCreate a calendar
- GETGet color palettes
- PATCHRename a calendar group
- DELETEDelete a calendar group
- GETGet a calendar
- PATCHUpdate a calendar
- DELETEDelete a calendar
- POSTSubscribe to a calendar
- GETList categories
- POSTCreate a category
- GETGet a calendar's feed
- PUTEnable a calendar's feed
- DELETEDisable a calendar's feed
- GETList calendar permissions
- POSTShare a calendar
- DELETEUnsubscribe from a calendar
- PATCHUpdate a category
- DELETEDelete a category
- POSTRotate a feed's link
- PATCHUpdate a calendar permission
- DELETEDelete a calendar permission
Events
Manage events across Google Calendar, Microsoft Outlook and virtual calendars, including metadata, attachments and conferencing.
- GETList events
- POSTCreate an event
- GETGet an event
- PATCHUpdate an event
- DELETEDelete an event
- POSTImport an event
- POSTCreate an event from text
- GETList an event's attachments
- POSTAttach a link
- POSTForward an invitation
- GETList occurrences of a recurring event
- POSTMove an event to another calendar
- POSTRespond to an invitation
- DELETEDelete an attachment
- POSTUpload a file to an event
- POSTDismiss a reminder
- POSTSnooze a reminder
- GETDownload an attachment
Availability
Check free/busy information, find meeting times and find rooms.
Meetings
Meetings on their own, with no calendar event: Zoom meetings (list, get, create, change, delete), Microsoft Teams meetings (get, create, change, delete) and Google Meet links (get, create, change settings). To add a meeting to an event, use conferencing on the event.
Invitations
Invitations sent for virtual calendars.
Webhooks
Receive events at your own endpoints through signed, retried and recorded deliveries. Includes replays, test deliveries and a relay for sandbox events.
- GETList webhook endpoints
- POSTCreate a webhook endpoint
- GETGet a webhook endpoint
- PATCHUpdate a webhook endpoint
- DELETEDelete a webhook endpoint
- GETList webhook deliveries
- GETList webhook event types
- GETList webhook events
- GETStream sandbox webhook events
- POSTReplay failed webhook deliveries
- GETRetrieve the signing secret
- POSTSend a test delivery
- GETGet a webhook delivery
- GETGet a webhook event
- POSTRotate the signing secret
- POSTReplay a webhook delivery
Metadata
Import the extended properties stored at the provider into Pyas metadata.
Keys
List API keys, and rotate a key with a grace period during which both the old and new keys work.
Sandbox
The sandbox environment that test keys work in.
Usage
Retrieve API usage by day.
Logs
Look up any v2 request by its trace ID to see what was requested, what the API responded and why, and what happened while the request was processed.