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

# Listar pixels de rastreamento

> Lista os pixels de rastreamento da empresa autenticada, do mais recente para o mais antigo, com paginação e filtro opcional por produto ou por checkout. Use antes de auditar o rastreamento de uma campanha ou para descobrir o id de um pixel que você vai remover. O token da API de conversões nunca é devolvido: só o indicador `hasCapiToken`.



## OpenAPI

````yaml /openapi.yaml get /v1/pixels
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/pixels:
    get:
      tags:
        - Checkout
      summary: Listar pixels de rastreamento
      description: >-
        Lista os pixels de rastreamento da empresa autenticada, do mais recente
        para o mais antigo, com paginação e filtro opcional por produto ou por
        checkout. Use antes de auditar o rastreamento de uma campanha ou para
        descobrir o id de um pixel que você vai remover. O token da API de
        conversões nunca é devolvido: só o indicador `hasCapiToken`.
      operationId: listPixels
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
          description: Página desejada, começando em 1.
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: pageSize
          required: false
          description: Quantidade de itens por página (máximo 100).
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: productId
          required: false
          description: Filtra pelos pixels ligados a este produto.
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: checkoutId
          required: false
          description: Filtra pelos pixels ligados a este checkout `v2`.
      responses:
        '200':
          description: Página de pixels da empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Identificador do pixel.
                        name:
                          type: string
                          nullable: true
                          description: Apelido do pixel escolhido pelo vendedor.
                        pixelCode:
                          type: string
                          description: Identificador do pixel na plataforma de anúncios.
                        provider:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Identificador do provedor de pixel.
                            name:
                              type: string
                              description: Nome do provedor exibido no painel.
                            type:
                              type: string
                              description: >-
                                Código curto do provedor usado pelo disparo
                                (`meta`, `gads`, `gtm`...).
                            slug:
                              type: string
                              description: Identificador textual estável do provedor.
                          required:
                            - id
                            - name
                            - type
                            - slug
                          additionalProperties: false
                          description: Plataforma de anúncios que recebe os eventos.
                        status:
                          type: boolean
                          description: '`false` pausa o disparo sem apagar a configuração.'
                        valueType:
                          type: string
                          enum:
                            - total_order_and_feess
                            - total_products_and_freight
                          description: >-
                            Qual valor é enviado na conversão: o total do pedido
                            com taxas ou o dos produtos com frete.
                        isMarkPix:
                          type: boolean
                          description: >-
                            Dispara a conversão já na geração do Pix, antes da
                            confirmação.
                        conversionLabel:
                          type: string
                          nullable: true
                          description: Rótulo de conversão do Google Ads.
                        conversionValue:
                          type: integer
                          nullable: true
                          description: Valor fixo de conversão em centavos, quando usado.
                        triggerOnCheckout:
                          type: boolean
                          description: Dispara o evento quando o comprador abre o checkout.
                        triggerOnBeginCheckout:
                          type: boolean
                          description: >-
                            Dispara o evento quando o comprador começa a
                            preencher.
                        hasCapiToken:
                          type: boolean
                          description: >-
                            Se há um token de API de conversões guardado. O
                            token nunca é devolvido.
                        testEventCode:
                          type: string
                          nullable: true
                          description: >-
                            Código de evento de teste do provedor, quando
                            configurado.
                        productIds:
                          type: array
                          items:
                            type: string
                          description: Produtos em que este pixel dispara.
                        createdAt:
                          type: string
                          format: date-time
                          description: Momento de criação do pixel.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Momento da última alteração.
                      required:
                        - id
                        - name
                        - pixelCode
                        - provider
                        - status
                        - valueType
                        - isMarkPix
                        - conversionLabel
                        - conversionValue
                        - triggerOnCheckout
                        - triggerOnBeginCheckout
                        - hasCapiToken
                        - testEventCode
                        - productIds
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Página devolvida.
                      pageSize:
                        type: integer
                        description: Itens por página pedidos.
                      total:
                        type: integer
                        description: Total de itens que satisfazem o filtro.
                      totalPages:
                        type: integer
                        description: Total de páginas disponíveis.
                    required:
                      - page
                      - pageSize
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - pagination
                additionalProperties: false
                description: Página de pixels da empresa.
              example:
                success: true
                data:
                  - id: 3187
                    name: Meta — Curso de Tráfego Pago
                    pixelCode: '1284937561029384'
                    provider:
                      id: '1'
                      name: Meta Ads
                      type: meta
                      slug: meta-ads
                    status: true
                    valueType: total_order_and_feess
                    isMarkPix: false
                    conversionLabel: null
                    conversionValue: null
                    triggerOnCheckout: true
                    triggerOnBeginCheckout: false
                    hasCapiToken: true
                    testEventCode: TEST48291
                    productIds:
                      - clx8a2h4k0001qz0a1b2c3d4e
                    createdAt: '2026-08-19T14:02:00.000Z'
                    updatedAt: '2026-09-10T09:31:00.000Z'
                pagination:
                  page: 1
                  pageSize: 10
                  total: 1
                  totalPages: 1
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````