V3 Dashboards

Lists a workspace's dashboards, newest first, page by page, each with its widget count. filter[chartId][eq] lists the dashboards that hold a chart. Needs read access to the workspace.

get/api/v3/dashboards

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/dashboards
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

Query parameters

workspaceIdstring cuid2 required

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

limitinteger

Page size (max 250). Treat meta.nextCursor as the only end-of-collection signal.

cursorstring

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

filter[name][contains]string

Only dashboards whose name contains this text, ignoring case.

filter[chartId][eq]string cuid2

Only dashboards that hold this chart.

Response

A page of dashboards

Changes