From 9d397428028fe5c74375fec98f9d3e75f60e4b48 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 12 Nov 2025 04:07:28 +0000 Subject: [PATCH] Add API v1 deprecation banners (#25065) * 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> --- docs/api-reference/v1/authentication.mdx | 4 ++++ docs/api-reference/v1/errors.mdx | 4 ++++ docs/api-reference/v1/introduction.mdx | 4 ++++ docs/api-reference/v1/rate-limit.mdx | 4 ++++ docs/mint.json | 6 +++++- 5 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/api-reference/v1/authentication.mdx b/docs/api-reference/v1/authentication.mdx index 40ee0d68b0..a09bd30873 100644 --- a/docs/api-reference/v1/authentication.mdx +++ b/docs/api-reference/v1/authentication.mdx @@ -2,6 +2,10 @@ title: "Authentication" --- + +**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. + + The Cal.com API uses API keys to authenticate requests. You can view and manage your API keys in your settings page under the security tab in Cal.com. diff --git a/docs/api-reference/v1/errors.mdx b/docs/api-reference/v1/errors.mdx index edabcea533..4e36d66413 100644 --- a/docs/api-reference/v1/errors.mdx +++ b/docs/api-reference/v1/errors.mdx @@ -2,6 +2,10 @@ title: "Errors" --- + +**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. + + Cal.com uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, or something else failed, etc.). Codes in the 5xx range indicate an error with Cal.com's servers (these are rare). diff --git a/docs/api-reference/v1/introduction.mdx b/docs/api-reference/v1/introduction.mdx index bd14244d23..5c8a60716a 100644 --- a/docs/api-reference/v1/introduction.mdx +++ b/docs/api-reference/v1/introduction.mdx @@ -2,6 +2,10 @@ title: "Quick start" --- + +**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. + + ## 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. diff --git a/docs/api-reference/v1/rate-limit.mdx b/docs/api-reference/v1/rate-limit.mdx index b62b0fe050..c48ceac063 100644 --- a/docs/api-reference/v1/rate-limit.mdx +++ b/docs/api-reference/v1/rate-limit.mdx @@ -2,6 +2,10 @@ title: "Rate limits" --- + +**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. + + We limit the number of calls you can make over a certain period of time. Rate limits vary and are specified by the following header in all responses:
diff --git a/docs/mint.json b/docs/mint.json index 5ac640a68a..e0d97b2011 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -52,7 +52,11 @@ { "name": "API v1 Reference", "openapi": "/api-reference/v1/openapi-v1.json", - "url": "api-reference/v1" + "url": "api-reference/v1", + "banner": { + "type": "warning", + "content": "API v1 will be discontinued on February 15, 2026. Please migrate to [API v2](/api-reference/v2/introduction)." + } } ], "navigation": [