mirror of
https://github.com/formbricks/formbricks.git
synced 2026-01-05 16:19:55 -06:00
chore: add api v2 draft docs (#4783)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
14
docs/api-v2-reference/introduction.mdx
Normal file
14
docs/api-v2-reference/introduction.mdx
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "API v2 Reference (Draft)"
|
||||
icon: "code-compare"
|
||||
---
|
||||
|
||||
Formbricks offers two types of APIs: the **Public Client API** and the **Management API**. Each API serves a different purpose, has *different* authentication requirements, and provides access to different data and settings.
|
||||
|
||||
### API Key Setup
|
||||
|
||||
Checkout the [API Key Setup](/api-reference/rest-api) to access the Management APIs with an API Key.
|
||||
|
||||
If you’ve forked the collection and are running it, update the `apiKey` and `environmentId` in the collection variables with your values. We also provide post-run scripts to help auto-assign variables when running scripts.
|
||||
|
||||
Need more help? Visit our [Website](https://formbricks.com/) or join our [Discord](https://formbricks.com/discord)!
|
||||
1088
docs/api-v2-reference/openapi.yml
Normal file
1088
docs/api-v2-reference/openapi.yml
Normal file
File diff suppressed because it is too large
Load Diff
@@ -758,9 +758,14 @@
|
||||
"url": "development"
|
||||
},
|
||||
{
|
||||
"name": "API Reference",
|
||||
"name": "API v1 Reference",
|
||||
"openapi": "/api-reference/openapi.json",
|
||||
"url": "api-reference"
|
||||
},
|
||||
{
|
||||
"name": "API v2 Reference (Draft)",
|
||||
"openapi": "/api-v2-reference/openapi.yml",
|
||||
"url": "api-v2-reference"
|
||||
}
|
||||
],
|
||||
"topbarCtaButton": {
|
||||
|
||||
Reference in New Issue
Block a user