be728e9c01
* feat: Add Mintlify docs * Fixed the mint.json for v2 * Fixed versioning issue * Add titles to ICS feed endpoints * Added errors to v1 * Added rate-limit to API v1 * feat: added v1-v2 differences and v1 auth * Trying to eliminate reasons for v1 not showing on publication * Used the swagger openapi validator * remove deprecated v1 endpoints * Moved api docs into new folders without api-reference * Renamed api to api-reference * removed the versioning * Got rid of anchor warnings * Fixed naming * Just as a test - using the same v2 openapi spec for v1 reference * Removed 'externalDocs' from v1 * Removed securitySchemes * Updated the diff between v1/v2 * Added v1 in front of /attendees to test * Moved paths up and removed externalDocs * Testing - Added content to the response * Reduced paths to 1 * Testing: anything at this point * Fixed validation * Moved the other .mdx files to see if that's disrupting something * Trying with a tab * Empty tags array * Added back servers field * Removed all other schemas * Removed v1 for now * Added platform docs * Language fixes * Added v1 back * add API V1 response for attendees * remove unnecessary endpoint docs in API V1 * Removing platform and API for now * Updated v2 openapi doc --------- Co-authored-by: Syed Ali Shahbaz <alishahbaz7@gmail.com>
52 lines
1.4 KiB
Plaintext
52 lines
1.4 KiB
Plaintext
---
|
|
title: "Quick start"
|
|
---
|
|
|
|
## Get your API keys
|
|
|
|
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
|
|
|
|
You can generate an API key from **Settings >** [**Security**](https://app.cal.com/settings/security) within the application. There you will find the API keys section which allows you to generate a key for use.
|
|
|
|
More information on this can be found in the [Authentication](authentication) page.
|
|
|
|
## Install the library
|
|
|
|
The best way to interact with our API is using a good HTTP client like **axios**:
|
|
|
|
<Tabs>
|
|
<Tab title="Node">
|
|
```
|
|
# Install via NPM
|
|
npm install --save axios
|
|
|
|
# Install via Yarn
|
|
yarn add axios
|
|
```
|
|
</Tab>
|
|
<Tab title="Python">
|
|
```
|
|
# Install via pip
|
|
pip install --upgrade requests
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Make your first request
|
|
|
|
To make your first request, send an authenticated request to the event-types endpoint. This will list all of your event types.
|
|
|
|
Example using `curl`:
|
|
|
|
<Tabs>
|
|
<Tab title="Curl">
|
|
```
|
|
curl https://api.cal.com/v1/event-types?apiKey=cal_test_xxxxxx
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Try our Postman Collection
|
|
|
|
We've created a small collection of frequently made API calls that you can try in our [Postman Collection](https://www.postman.com/calcom/workspace/cd670dd8-b36d-4aee-8ab2-9044122e30d1/collection/20666831-b92a1d73-bfcc-4a5f-9ef5-cb117d49c904)
|