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

# Get a Lead Capture pop-up

> Get one pop-up in full: its whole config (design, copy, fields, trigger, game, prizes and codes), the install tag, and anything still stopping it from going live. Edit any part of the config and send it back with lead_capture_forms_update.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/lead-capture/forms/{formId}
openapi: 3.1.0
info:
  title: Boom API
  version: 1.0.0
  description: >-
    Boom's public REST API — one uniform surface over every platform capability.
    CDP: upsert people and custom objects, define object and relationship types,
    link and unlink relationships, and record behavioral events — one record per
    request or up to 1000 per request via the `/batch` endpoints. Segments: read
    (list, read, membership) and full authoring — discover the filterable
    catalog, validate a filter, create and update segments, preview match
    counts, and trigger evaluation. Initiatives: create and configure outreach
    initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel,
    archive), and read collected-data summaries. Participants: enroll people
    into an active initiative, track their status, read conversation
    transcripts, and stop outreach. Journeys: read-only access to always-on
    message flows and their metrics. WhatsApp templates: list your WhatsApp
    numbers and list, read, and create message templates. The same capabilities
    are exposed as MCP tools with identical schemas.
servers:
  - url: https://www.useboom.ai
    description: Production
  - url: https://dev.useboom.ai
    description: Development (sandbox — use a development organization API key)
security:
  - bearerAuth: []
paths:
  /api/v1/lead-capture/forms/{formId}:
    get:
      tags:
        - Lead Capture
      summary: Get a Lead Capture pop-up
      description: >-
        Get one pop-up in full: its whole config (design, copy, fields, trigger,
        game, prizes and codes), the install tag, and anything still stopping it
        from going live. Edit any part of the config and send it back with
        lead_capture_forms_update.
      operationId: lead_capture_forms_get
      parameters:
        - name: formId
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
            minLength: 1
            maxLength: 64
            description: Pop-up id.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                    enum:
                      - PAUSED
                      - ACTIVE
                    description: >-
                      ACTIVE shows it to visitors on the allowed sites; it is
                      refused, with the reasons, until the pop-up is ready (at
                      least one site, a prize per game, consent text for a
                      phone).
                  game:
                    type: string
                    description: The game, or `none` for a plain form.
                  allowedOrigins:
                    type: array
                    items:
                      type: string
                  installKey:
                    type: string
                    description: Public; identifies the pop-up in the install tag.
                  updatedAt:
                    type: string
                    description: ISO timestamp.
                  installTag:
                    type: string
                    description: The script tag to paste at the end of the page body.
                  buttonTag:
                    type: string
                    description: >-
                      A button that opens the pop-up when clicked, whatever its
                      trigger; with the trigger set to `click` it is the only
                      way it opens. The install tag must be on the page too.
                  config:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                    description: >-
                      The full design, copy, fields, trigger, game and prizes.
                      Send any part of it back as `config` to
                      `lead_capture_forms_update`. Text fields are `{ "en": "…",
                      "es": "…", "pt": "…" }`; `en` is required. If the stored
                      settings could no longer be read, this shows the defaults
                      and `liveIssues` says so; a patch then starts from the
                      defaults.
                  liveIssues:
                    type: array
                    items:
                      type: string
                    description: >-
                      Why it could not go live as it stands, one `field: reason`
                      per line. Empty when it is ready.
                required:
                  - id
                  - name
                  - status
                  - game
                  - allowedOrigins
                  - installKey
                  - updatedAt
                  - installTag
                  - buttonTag
                  - config
                  - liveIssues
                additionalProperties: false
        '400':
          description: Validation failed or the request cannot proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: The resource does not exist in this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: >-
            Conflicts with the current state (duplicates, wrong lifecycle
            state).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: The request is well-formed but semantically invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '429':
          description: Rate limit exceeded — retry after `Retry-After`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Transient error — retry with a narrower request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'

````

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