List action classes

Returns the action classes (user actions that can trigger an app survey) for a workspace. Use the returned ids as distribution.triggers[].actionClassId when creating or updating app surveys. Read-only: this v3 endpoint lists action classes but does not create them — action classes are managed in the Formbricks app (Actions settings) or via the v1/v2 management API.

An empty data array means the workspace has no action classes yet. Triggers are optional, so you can still create an app survey with distribution.triggers: [] (or omit distribution entirely) and attach triggers later via PATCH once an action class exists. Session cookie, x-api-key, or a Bearer token.

GET /api/v3/action-classes

List action classes

cURL

curl --request GET \
  --url https://app.formbricks.com/api/v3/action-classes \
  --cookie next-auth.session-token=

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "code",
      "key": "<string>"
    }
  ],
  "meta": {
    "limit": 2,
    "nextCursor": "<string>"
  }
}

Authorizations

sessionAuthapiKeyAuthbearerAuth

next-auth.session-token · string · cookie · required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId · string<cuid2> · required

Workspace identifier. This is the canonical container ID for v3 APIs.

limit · integer · default: 50

Page size (max 250).

Required range: 1 <= x <= 250

cursor · string

Opaque cursor returned as meta.nextCursor from the previous page. Omit on the first request.

Response

200

application/json

Action classes retrieved successfully

data · object[] · required

Show child attributes

meta · object · required

A list meta carrying pagination and nothing else — the shape for collections that do not report a total and have no domain context to echo.

Adds nothing to ListPaginationMeta; the allOf wrapper is what closes it. Each composing operation bounds its own requests through its limit query parameter, which is why this shape states no cap of its own.

Show child attributes