FOformbricks
V3 Creatives

Get a creative

Changed on

Returns one creative, with its derived displayStatus, displayStatusReason, warnings and destination.opensAs. Read access to the creative's workspace, which is resolved from the creative, so no workspaceId is accepted. An unknown or inaccessible creativeId answers 403, not 404, so creative ids cannot be probed for existence.

get/api/v3/creatives/{creativeId}

Request

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

Path parameters

creativeIdstring cuid2 required

Creative identifier.

Response

Creative retrieved successfully

Example response

{
  "data": {
    "defaultLanguage": "en-US",
    "languages": [
      {
        "code": "en-US"
      }
    ],
    "distribution": {
      "showOn": "pageView",
      "triggers": [],
      "conditions": null,
      "displayPercentage": null
    },
    "schedule": {
      "startAt": "2026-11-01T02:00:00.000Z",
      "endAt": "2026-11-01T04:00:00.000Z"
    },
    "content": {
      "label": {
        "en-US": "Feedback",
        "de-DE": "Feedback geben"
      }
    },
    "styling": {
      "position": {
        "desktop": {
          "edge": "right",
          "offset": 50
        },
        "phone": null
      },
      "theme": {
        "customStyles": false,
        "backgroundColor": null,
        "textColor": null,
        "borderColor": null,
        "borderRadius": null,
        "fontWeight": null,
        "fontSize": {
          "desktop": null,
          "phone": null
        },
        "paddingX": {
          "desktop": null,
          "phone": null
        },
        "paddingY": {
          "desktop": null,
          "phone": null
        }
      }
    }
  }
}

Changes

  • 03d5b9b896e2Revision changes
    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

  • 84820a01e550Revision changes
    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status