PRprivy
Displays

List displays

Changed on

Retrieve a paginated list of your on-site displays, newest first. Archived displays are excluded by default — pass status=archived to list them.

The display inventory — use it to enumerate or count displays, since /v1/reports/displays is a capped leaderboard that leaves out displays with no activity. Configuration only: views, signups, and attributed revenue come from /v1/reports/displays and /v1/reports/displays/{display_id}. Rows carry no show triggers or audience summary; /v1/displays/{id} adds those.

Required scope: displays_read

get/displays

Request

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

Query parameters

pageinteger

Page number (starts at 1).

per_pageinteger

Number of results per page. Values outside 10–100 are clamped to the nearest bound.

status'draft' | 'scheduled' | 'live' | 'paused' | 'ended' | 'archived'

Filter by display status.

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

A paginated list of displays.

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"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6
  }
}

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