mirror of
https://github.com/formbricks/formbricks.git
synced 2026-05-19 03:04:39 -05:00
Dhruwang Jariwala
939fedfca4
Signed-off-by: gulshank0 <gulshanbahadur002@gmail.com> Co-authored-by: Tiago Farto <tiago@formbricks.com> Co-authored-by: Johannes <72809645+jobenjada@users.noreply.github.com> Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Tiago <1585571+xernobyl@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Theodór Tómas <theodortomas@gmail.com> Co-authored-by: Anshuman Pandey <54475686+pandeymangg@users.noreply.github.com> Co-authored-by: Bhagya Amarasinghe <b.sithumini@yahoo.com> Co-authored-by: Chowdhury Tafsir Ahmed Siddiki <ctafsiras@gmail.com> Co-authored-by: neila <40727091+neila@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Harsh Bhat <90265455+harshsbhat@users.noreply.github.com> Co-authored-by: Harsh Bhat <harshbhat@Harshs-MacBook-Air.local> Co-authored-by: Johannes <johannes@formbricks.com> Co-authored-by: Balázs Úr <balazs@urbalazs.hu> Co-authored-by: Gulshan <gulshanbahadur002@gmail.com> Co-authored-by: Harsh Bhat <harsh121102@gmail.com> Co-authored-by: Javi Aguilar <122741+itsjavi@users.noreply.github.com> Co-authored-by: Johannes <jobenjada@users.noreply.github.com>
45 lines
2.2 KiB
Plaintext
45 lines
2.2 KiB
Plaintext
---
|
||
title: "REST API"
|
||
icon: "code"
|
||
description: "
|
||
Formbricks provides two APIs: the Public Client API for frontend survey interactions and the Management API for backend management tasks."
|
||
---
|
||
|
||
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.
|
||
|
||
|
||
## Public Client API
|
||
|
||
The **Public Client API** is used by our SDKs and doesn’t require authentication, making it ideal for client-side interactions without exposing sensitive data.
|
||
|
||
We currently have the following Client API methods exposed and below is their documentation attached in Postman:
|
||
|
||
- [Displays API](/api-reference/client-api--display/create-display) - Mark a survey as displayed or link a display to a response for a person.
|
||
|
||
- [Responses API](/api-reference/client-api--response/create-response) - Create & Update a Response for a Survey.
|
||
|
||
## Management API
|
||
|
||
The **Management API** gives full access to all data and settings available in your Formbricks account. It requires a personal API Key for authentication, which you can generate and manage in the Settings section of the Formbricks app.
|
||
|
||
We currently have the following Management API methods exposed and below is their documentation attached in Postman:
|
||
|
||
- [Action Class API](/api-reference/management-api--action-class/get-all-action-classes) - Create, List, and Delete Action Classes
|
||
|
||
- [Contact Attribute Keys API](/api-reference/management-api--contact-attribute-keys/get-all-contact-attribute-keys) - List Contact Attribute Keys
|
||
|
||
- [Contacts API](/api-reference/management-api--contacts/get-all-contacts) - List Contacts
|
||
|
||
- [Me API](/api-reference/management-api--me/me) - Retrieve Account Information
|
||
|
||
- [Response API](/api-reference/management-api--response/get-survey-responses) - List, List by Survey, Update, and Delete Responses
|
||
|
||
- [Survey API](/api-reference/management-api--survey/get-all-surveys) - List, Create, Update, generate multiple suId, and Delete Surveys
|
||
|
||
- [Webhook API](/api-reference/management-api--webhook/get-all-webhooks) - List, Create, and Delete Webhooks
|
||
|
||
|
||
|
||
---
|
||
|
||
**Need help?** Reach out in [GitHub Discussions](https://github.com/formbricks/formbricks/discussions). |