Introduction

Pyas API Reference

Overview

The Pyas API allows developers to easily add Google Calendar, Outlook, and Zoom integrations into their apps. Through our API, developers can connect accounts, perform CRUD operations to calendar events on both Google Calendar and Microsoft Outlook, and perform CRUD operations to Zoom meetings.

Our API is based on REST architecture and is accessed via HTTPS. The base URL for all requests is https://api.pyas.io/ . The complete URL varies depending on the endpoint of the resource being accessed.

All API endpoints are protected and can only be accessed using API keys. All API keys are app based and you can generate as many as you need by logging into your Pyas account and going to your app's settings.

API keys must be sent in an x-api-key request header.

Rate Limit

The maximum number of requests that are allowed is based on a 5-minute window timeframe. Each plan has a different limit, as follows:

Developer Plans: 100 API calls per 5-minute window (This is equivalent to 20 calls per minute or 1,200 calls per hour). Note: There's a 2,000 monthly API call limit on the Developer Plans.

Growth Plans: 3,000 API calls per 5-minute window (This is equivalent to 600 calls per minute or 36,000 calls per hour)

Scale Plans: 5,000 API calls per 5-minute window (This is equivalent to 1,000 calls per minute or 60,000 calls per hour)

If you exceed this limit, you will get a 429 response that looks like this:

{
    "message": "Too many requests! You have exceeded the maximum requests allowed per 5-minute window.",
    "code": 429,
    "error": "Rate limit exceeded"
}

The rate limit is based on API Key. If you have multiple API keys, each one will be rate limited to the limits described above.

You may read the Retry-After (seconds) or X-RateLimit-Reset (date) response headers in order to know when you can restart your requests. In addition, the X-RateLimit-Remaining header displays the remaining available requests you can make in the current 5-minute window.