9d39742802
* Update docs/api-reference/v1/introduction.mdx * Update docs/api-reference/v1/authentication.mdx * Update docs/api-reference/v1/errors.mdx * Update docs/api-reference/v1/rate-limit.mdx * Update docs/mint.json --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
56 lines
1.6 KiB
Plaintext
56 lines
1.6 KiB
Plaintext
---
|
|
title: "Quick start"
|
|
---
|
|
|
|
<Warning>
|
|
**API v1 is deprecated and will be discontinued on February 15, 2026.** Please migrate to [API v2](/api-reference/v2/introduction) as soon as possible.
|
|
</Warning>
|
|
|
|
## 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)
|