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

# Get form

> Get a form.



## OpenAPI

````yaml /en/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists/{id}
openapi: 3.0.3
info:
  title: Notifique API. Forms (marketing add-on)
  description: >-
    API v1 para **formulários de marketing** (templates: BLANK, CONTACT, SURVEY,
    WAITLIST, NEWSLETTER) em `/v1/forms`.


    **Autenticação:** `Authorization: Bearer sk_live_xxxxx` ou cabeçalho
    `x-api-key`.


    **Escopos:**

    - **forms:manage**, listar, criar, atualizar e excluir formulários; listar
    inscrições.

    - **forms:submit**, criar inscrições, confirmar double opt-in e cancelar.


    **Validação:** submissões API validam contra o schema `hostedPageForm` do
    formulário.


    **Webhooks:** `form.submitted`, `form.confirmed`, `form.unsubscribed`.


    **403** com `code: ONBOARDING_REQUIRED` se o onboarding não estiver
    concluído.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfAddonsBearerAuth: []
  - ntfAddonsApiKeyHeader: []
tags:
  - name: Forms
    description: >-
      Formulários de marketing unificados (`/v1/forms/*`). Escopos:
      **forms:manage**, **forms:submit**.
paths:
  /v1/forms/lists/{id}:
    get:
      tags:
        - Forms
      summary: Get form
      description: Get a form.
      operationId: ntfAddons_getV1FormsList
      parameters:
        - $ref: '#/components/parameters/MarketingListId'
      responses:
        '200':
          description: Formulário
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfAddons_FormListEnvelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFoundForm'
components:
  parameters:
    MarketingListId:
      name: id
      in: path
      required: true
      description: 'ID da lista (ex.: cuid)'
      schema:
        type: string
  schemas:
    NtfAddons_FormListEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/NtfAddons_FormList'
    NtfAddons_FormList:
      type: object
      required:
        - id
        - addonType
        - template
        - features
        - name
        - status
        - doubleOptInEnabled
        - subscriptionsCount
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        addonType:
          type: string
          enum:
            - FORM
        template:
          type: string
          enum:
            - BLANK
            - CONTACT
            - SURVEY
            - WAITLIST
            - NEWSLETTER
        features:
          $ref: '#/components/schemas/NtfAddons_FormFeatures'
        name:
          type: string
        status:
          $ref: '#/components/schemas/NtfAddons_MarketingListStatus'
        doubleOptInEnabled:
          type: boolean
          description: Sempre false para template NEWSLETTER.
        endedMessage:
          type: string
          nullable: true
        hostedPageTheme:
          type: object
          nullable: true
          description: Tema da página hospedada.
        hostedPageCopy:
          type: object
          nullable: true
          description: Textos da página hospedada.
        hostedPageForm:
          type: object
          nullable: true
          description: Schema de campos do formulário.
        subscriptionsCount:
          type: integer
          minimum: 0
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    NtfAddons_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: HTTP-style error label (e.g. Unauthorized, Bad Request, Not Found).
        message:
          type: string
          description: >-
            Human-readable message for end users (localized via Accept-Language
            / x-locale when applicable).
        code:
          type: string
          description: >-
            Stable API v1 code (enum). Always present on errors. Use with the
            HTTP status to decide retry or fix. See [Error
            responses](/en/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfAddons_FormFeatures:
      type: object
      properties:
        queue:
          type: boolean
        doubleOptIn:
          type: boolean
        captureContact:
          type: boolean
    NtfAddons_MarketingListStatus:
      type: string
      enum:
        - ACTIVE
        - PAUSED
        - CLOSED
        - ENDED
  responses:
    BadRequest:
      description: Validação
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfAddons_ErrorResponse'
    Unauthorized:
      description: API Key ausente ou inválida
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfAddons_ErrorResponse'
    PaymentRequired:
      description: Plano expirado ou workspace suspenso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfAddons_ErrorResponse'
    Forbidden:
      description: Escopo insuficiente ou onboarding incompleto (`ONBOARDING_REQUIRED`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfAddons_ErrorResponse'
    NotFoundForm:
      description: Formulário não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfAddons_ErrorResponse'
  securitySchemes:
    ntfAddonsBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfAddonsApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````