> ## Documentation Index > Fetch the complete documentation index at: https://help.privy.com/llms.txt > Use this file to discover all available pages before exploring further. # List displays > 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` ## OpenAPI ````yaml openapi/privy-api.yaml GET /displays openapi: 3.1.0 info: title: Privy API version: '1.0' description: > The Privy API lets you programmatically manage your contact list and read what you have set up in Privy. Create, update, unsubscribe, and remove contacts; report orders; and read your campaigns, flows, segments, orders, store products, coupon pools, performance reports, and account setup. servers: - url: https://api.privy.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: Retrieve information about the authenticated Privy account. - name: Contacts description: Manage your contact list. - name: Imports description: >- Read your contact import history — CSV uploads, connected-provider syncs, and SMS consent imports. - name: Campaigns description: >- Read your message campaigns — email and SMS newsletters, plus the messages your flows send. - name: Displays description: >- Read your on-site displays (popups, flyouts, banners, embedded forms, landing pages). - name: Coupons description: Read your coupon pools, their code inventory, and individual codes. - name: Reports description: >- Read performance reporting — signups, views, conversion rates, and attributed revenue — for your business, displays, and flows. - name: Flows description: Read your automation flows and their configuration. - name: Segments description: Read your customer segments and their membership. - name: Orders description: Report orders placed in your store and read your order history. - name: Products description: Read the product catalog and collections of your connected store. - name: Events description: Ingest custom events to trigger Flows and other automations. paths: /displays: get: tags: - Displays summary: List displays description: > 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` operationId: listDisplays parameters: - $ref: '#/components/parameters/AccountIdParam' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' - name: status in: query description: Filter by display status. schema: type: string enum: - draft - scheduled - live - paused - ended - archived example: live responses: '200': description: A paginated list of displays. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Display' pagination: $ref: '#/components/schemas/PaginationEnvelope' example: data: - id: gk2P8Zw1Lq title: Summer Sale Popup display_type: popup goal: signup status: live starts_at: '2026-06-01T00:00:00Z' ends_at: null ab_test: present: false state: null created_at: '2026-05-20T10:00:00Z' pagination: page: 1 per_page: 40 total_count: 12 total_pages: 1 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientScope' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: AccountIdParam: name: Privy-Account-Id in: header required: false description: > 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. schema: type: string example: S1U2B3A4C5C6T7 PageParam: name: page in: query description: Page number (starts at 1). schema: type: integer default: 1 minimum: 1 example: 1 PerPageParam: name: per_page in: query description: >- Number of results per page. Values outside 10–100 are clamped to the nearest bound. schema: type: integer default: 40 minimum: 10 maximum: 100 example: 40 schemas: Display: type: object properties: id: type: string description: >- Stable, unique identifier for the display. Use this value in `/v1/displays/{id}`. example: gk2P8Zw1Lq title: type: - string - 'null' example: Summer Sale Popup display_type: type: - string - 'null' enum: - popup - flyout - banner - bar - spin_to_win - embedded_form - landing_page - thank_you_page - multi_display - null description: >- The display's on-site shape. `null` when the display's shape cannot be derived. example: popup goal: type: - string - 'null' description: What the display is optimized for. example: signup status: type: string enum: - draft - scheduled - live - paused - ended - archived description: > - `draft` — creation not completed. - `scheduled` — completed, scheduled to start later. - `live` — running and enabled on the site. - `paused` — running window but disabled. - `ended` — schedule window has passed. - `archived` — archived by the merchant (excluded from the list unless `status=archived`). example: live starts_at: type: - string - 'null' format: date-time example: '2026-06-01T00:00:00Z' ends_at: type: - string - 'null' format: date-time example: null ab_test: type: object properties: present: type: boolean example: false state: type: - string - 'null' description: State of the display's A/B test, when one exists. example: null coupon: oneOf: - $ref: '#/components/schemas/CouponRef' - type: 'null' description: The coupon pool this display hands out codes from, `null` when none. created_at: type: string format: date-time example: '2026-05-20T10:00:00Z' PaginationEnvelope: type: object properties: page: type: integer example: 1 per_page: type: integer example: 25 total_count: type: integer example: 142 total_pages: type: integer example: 6 CouponRef: type: object description: > The coupon pool attached to a message or display — a `{{ coupon_code }}` tag in the content only renders when one is attached. Pass `id` to `GET /v1/coupons/{id}` for the pool's inventory and health; `kind` and `platform` match that endpoint's rows. properties: id: type: string description: The pool's identifier, as returned by `GET /v1/coupons`. example: Xk2fW9qLpV title: type: string example: Welcome 10% kind: type: string enum: - master - unique description: >- `master` is a single shared code; `unique` is a pool of individually generated codes. platform: type: string enum: - manual - shopify - bigcommerce - woocommerce ErrorResponse: type: object properties: error: type: object required: - code - message properties: code: type: string enum: - invalid_client - invalid_scope - unauthorized - insufficient_scope - paid_plan_required - api_access_required - not_found - no_connected_store - conflict - contacts_not_ready - validation_failed - rate_limited - store_unavailable example: validation_failed message: type: string example: One or more fields are invalid details: type: array items: type: object properties: field: type: string example: email message: type: string example: is required responses: Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: Bearer token is missing or invalid InsufficientScope: description: Token lacks the required scope for this endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: insufficient_scope message: Token does not have the required scope ValidationFailed: description: One or more fields failed validation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: validation_failed message: One or more fields are invalid details: - field: email message: is required RateLimited: description: Rate limit exceeded. Retry after the specified time. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 42 X-RateLimit-Limit-Minute: description: Maximum requests allowed per minute. schema: type: integer example: 60 X-RateLimit-Remaining-Minute: description: Requests remaining in the current minute window. schema: type: integer example: 0 X-RateLimit-Reset-Minute: description: Unix timestamp when the minute window resets. schema: type: integer example: 1711929600 X-RateLimit-Limit-Day: description: Maximum requests allowed per day. schema: type: integer example: 10000 X-RateLimit-Remaining-Day: description: Requests remaining in the current day window. schema: type: integer example: 9500 X-RateLimit-Reset-Day: description: Unix timestamp when the day window resets. schema: type: integer example: 1712016000 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limited message: Rate limit exceeded securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API token or OAuth access token description: > Send either an API token or an OAuth access token as `Authorization: Bearer `. See the Authentication page for details. ````