Test API Key

To test if your API key is working, you can use the following request:

Mandatory Headers

Name	x-Api-Key
Type	string
Description	Your Formbricks API key.

Request

cURL

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",
  "workspace": {
      "id": "cll2m30r60003mx0hnemjfckr",
      "name": "My Workspace"
  },
  "appSetupCompleted": false,
  "websiteSetupCompleted": false,
}

Not authenticated

Generate API Key Create Display

API v1 Documentation

Client API - Display

Client API - Environment

Client API - Response

Client API - User

Management API - Action Class

Management API - Contact Attribute Keys

Management API - Contact Attributes

Management API - Contacts

Management API - Me

Management API - Response

Management API - Storage

Management API - Survey

Management API - Webhook

Health

Mandatory Headers

Request

Response

​Mandatory Headers

​Request

​Response

Mandatory Headers

Request

Response