REST API

​

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 - Mark a survey as displayed or link a display to a response for a person.

• People API - Create & Update a Person (e.g., attributes, email, userId, etc.)

• Responses API - 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 - Create, List, and Delete Action Classes

• Attribute Class API - Create, List, and Delete Attribute Classes

• Me API - Retrieve Account Information

• People API - List and Delete People

• Response API - List, List by Survey, Update, and Delete Responses

• Survey API - List, Create, Update, generate multiple suId, and Delete Surveys

• Webhook API - List, Create, and Delete Webhooks

​

How to Generate an API key

API requests require a personal API key for authorization. This API key gives you the same rights as if you were logged in at Formbricks UI - keep it private!

• Go to your settings on Formbricks UI.

• Go to page “API keys”

• Create a key for the development or production environment.

• Copy the key immediately. You won’t be able to see it again.

​

Test your API Key

Hit the below request to verify that you are authenticated with your API Key and the server is responding.

​

Get My Profile

Get the project details and environment type of your account.

​

Mandatory Headers

​

Request

GET - /api/v1/me

curl --location \
'https://app.formbricks.com/api/v1/me' \
--header \
'x-api-key: <your-api-key>'

​

Response

{
  "id": "cll2m30r70004mx0huqkitgqv",
  "createdAt": "2023-08-08T18:04:59.922Z",
  "updatedAt": "2023-08-08T18:04:59.922Z",
  "type": "production",
  "project": {
      "id": "cll2m30r60003mx0hnemjfckr",
      "name": "My Project"
  },
  "appSetupCompleted": false,
  "websiteSetupCompleted": false,
}

​

Delete a personal API key

• Go to settings on app.formbricks.com.

• Go to the page “API keys”.

• Find the key you wish to revoke and select “Delete”.

• Your API key will stop working immediately.

Can’t figure it out? Get help in GitHub Discussions.