Test API Key

Here is how you can test your API key to make sure it is working.

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

200 (Success)

{
  "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,
}