PRprivy
Displays

Get a display

Changed on

Retrieve a single display by its identifier, including its show triggers and audience summary.

Configuration only — no views, signups, attributed revenue, or A/B test results. Those are in /v1/reports/displays/{display_id}, keyed on the same identifier. Over a /v1/displays row this adds the show triggers and the audience summary.

Required scope: displays_read

get/displays/{id}

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The display's unique identifier (returned as id in display responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list displays and match by title instead.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

The display.

Example response

{
  "data": {
    "id": "gk2P8Zw1Lq",
    "title": "Summer Sale Popup",
    "display_type": "popup",
    "goal": "signup",
    "status": "live",
    "starts_at": "2026-06-01T00:00:00Z",
    "coupon": {
      "id": "Xk2fW9qLpV",
      "title": "Welcome 10%"
    },
    "created_at": "2026-05-20T10:00:00Z",
    "triggers": {
      "auto_show_after_seconds": 5
    },
    "after_signup_email": {
      "enabled": true,
      "subject": "Take 10% Off"
    },
    "updated_at": "2026-06-10T15:30:00Z"
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • fe500ab59b3bRevision changes
    • info

      endpoint added