Test an API key

Send a server-side request to your instance. For a key scoped to exactly one workspace:

curl --fail-with-body 'https://<your-formbricks-domain>/api/v1/management/me'   --header 'x-api-key: <your-api-key>'

A successful 200 response has this shape:

{
  "id": "legacy-environment-id-or-workspace-id",
  "type": "production",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "appSetupCompleted": true,
  "workspace": { "id": "workspace-id", "name": "My workspace" },
  "project": { "id": "workspace-id", "name": "My workspace" }
}

project and the top-level legacy environment ID are retained for v1 compatibility.

401: check the key and instance URL.
400: this legacy endpoint requires exactly one workspace scope. Use GET /api/v2/me for an organization-only or multi-workspace key with organization read access. Without that permission, /api/v2/me returns 401 even for a valid key. Test an authorized workspace endpoint instead; do not broaden the key just to run this check.
403 on another endpoint: inspect its required scopes and the key’s workspace access.

See key setup. Keep keys out of client-side code and shared logs.

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

Client API - Creatives

Health