> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# popup

> Fetch a single popup by its id. Ids from earlier versions of the Redo API are also accepted.

**Required scopes:** [`campaigns_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-campaigns_read)

## Arguments

**id** `ID!` *required*

The popup's `id`, or its `legacyId` from an earlier version of the Redo API.

## Returns

**popup** `[Popup](/docs/api-reference/v3/reference/marketing/popup)`

A storefront popup: a modal, full-screen or panel form shown to shoppers, often to collect email and SMS signups. Views and signups are not here; read them from an analytics report.

**fields**

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the popup was created.

**id** `ID!` *required*

The id of this popup.

**legacyId** `String!` *required*

The popup's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

**name** `String!` *required*

The merchant-facing name of the popup. Empty when it has none.

**publishedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the popup was last published. Null while it is unpublished.

**status** `[PopupStatus!](/docs/api-reference/v3/reference/marketing/popup-status)` *required*

Whether the popup is published.

**target** `[PopupTarget](/docs/api-reference/v3/reference/marketing/popup-target)`

Which visitors the popup is shown to. Null when it has no audience setting.

**triggers** `[\[PopupTrigger!\]!](/docs/api-reference/v3/reference/marketing/popup-trigger)` *required*

What shows the popup, in the order the dashboard lists them. Only INLINE when it is embedded. Empty when no trigger is on.

**fields**

**delaySeconds** `Int`

For TIME\_ON\_PAGE, how many seconds the shopper is on the page before the popup shows. Null for other kinds.

**kind** `[PopupTriggerKind!](/docs/api-reference/v3/reference/marketing/popup-trigger-kind)` *required*

What shows the popup.

**type** `[PopupType!](/docs/api-reference/v3/reference/marketing/popup-type)` *required*

How the popup is laid out on desktop, from its first step. POPUP when it has no steps.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the popup was last edited.

## Example

```graphql theme={null}
query {
  popup(id: "...") {
    createdAt
    id
    legacyId
    name
    publishedAt
    status
    target
    type
    # ...
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.