Listagem de Campanhas

Retorna a lista de campanhas do parceiro.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

isEnded

boolean

opcional

Especifica se retorna campanhas finalizadas.

dataLimit

integer

opcional

Limite para quantidade de registros retornados.

dataPage

integer

opcional

Paginação: Offset.

participating

boolean

opcional

personDocumentNumber

string

opcional

Número do CPF. Se informado, retorna campanhas onde o usuário participa.

Exemplo:

11122233344

latitude

number

opcional

Geolocalização do parceiro.

Exemplo:

-47.040916

longitude

number

opcional

Geolocalização do parceiro.

Exemplo:

-22.98495

partnerId

integer

opcional

Id do parceiro.

showTest

boolean

opcional

Mostra campanhas de teste.

Padrão:

false

typeEnum

integer

opcional

Tipo de campanha.

string

opcional

Se informado, irá buscar campanhas ou parceiros com este termo.

startDate

string

opcional

Retorna campanhas com data de início iguais ou maiores do que a data informada.

Exemplo:

2025-03-12

endDate

string

opcional

Retorna campanhas com data de término iguais ou menores do que a data informada.

Padrão:

2025-12-25

exclusiveFilters

array[string]

opcional

Filtros exclusivos.

ids

array[string]

opcional

Retorna apenas campanhas informadas no array.

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Success

application/json

Body

status

string

requerido

Exemplo:

success

code

integer

requerido

Exemplo:

200

message

string

requerido

Padrão:

Exemplo:

error

boolean | null

requerido

dataCount

integer

requerido

Quantidade de registros retornados

Exemplo:

dataLimit

integer

requerido

Exemplo:

dataCurrentPage

integer

requerido

Exemplo:

dataLastPage

integer

requerido

Exemplo:

data

array [object {29}]

requerido

integer

requerido

ID da campanha.

Exemplo:

1234

title

string

requerido

Nome da campanha.

Exemplo:

Campanha Mães 2025

hashtag

string

requerido

Hashtag definida para a campanha.

Exemplo:

maes2025

campaignBanner

string

requerido

URI do banner da campanha.

startDate

string

requerido

Data de início da campanha.

Exemplo:

2025-12-25T00:00:00-03:00

endDate

string

requerido

Data de término da campanha.

Exemplo:

2025-12-30T00:00:00-03:00

partnerId

integer

requerido

ID do parceiro

Exemplo:

1234

partnerName

string

requerido

Nome do parceiro

Exemplo:

Parceiro Ltda

partnerCity

string

requerido

Cidade

Exemplo:

Maringá

partnerState

string

requerido

Estado

Exemplo:

partnerLatitude

string

requerido

Exemplo:

-22.98495

partnerLongitude

string

requerido

Exemplo:

-47.040916

partnerLogo

string | null

requerido

distance

string | null

requerido

participating

boolean

requerido

sentInvoice

string | null

requerido

ended

boolean

requerido

isCampaignTest

boolean

requerido

Informa se é uma campanha de teste.

typeEnum

integer

deprecated

type

array[string]

requerido

Tipo da campanha.

Valores permitidos:

coupomprizeGivingunique_bidlotteryhintsealeddream_treestamp

inputTypesEnum

integer

deprecated

prizorGreenButton

boolean

requerido

exclusiveFilters

array[string]

requerido

prizorAppCameraEnabled

boolean

requerido

Habilitar câmera no Prizor App.

crmall

object

requerido

API do 4C da campanha.

baseUnica

object

requerido

API da Base Única da campanha.

inputTypes

array[string]

requerido

Tipos de documentos aceitos.

Valores permitidos:

receiptnfenfcemanualtoken

prizorKioskUnlockByTouch

string

requerido

Exemplo:

fullService

prizorKioskUnlockByQRCode

string

requerido

Exemplo:

disabledenabled

Exemplo

{
    "status": "success",
    "code": 200,
    "message": "''",
    "error": null,
    "dataCount": 10,
    "dataLimit": 10,
    "dataCurrentPage": 1,
    "dataLastPage": 1,
    "data": [
        {
            "id": 1234,
            "title": "Campanha Mães 2025",
            "hashtag": "maes2025",
            "campaignBanner": "ut minim adipisicing",
            "startDate": "2025-12-25T00:00:00-03:00",
            "endDate": "2025-12-30T00:00:00-03:00",
            "partnerId": 1234,
            "partnerName": "Parceiro Ltda",
            "partnerCity": "Maringá",
            "partnerState": "PR",
            "partnerLatitude": "-22.98495",
            "partnerLongitude": "-47.040916",
            "partnerLogo": "https://avatars.githubusercontent.com/u/77899800",
            "distance": "reprehenderit in veniam velit",
            "participating": false,
            "sentInvoice": "sit nisi Duis sunt",
            "ended": false,
            "isCampaignTest": false,
            "typeEnum": 77,
            "type": [
                "coupom",
                "sealed",
                "coupom"
            ],
            "inputTypesEnum": 3,
            "prizorGreenButton": false,
            "exclusiveFilters": [
                "dolore do fugiat eu officia",
                "in commodo"
            ],
            "prizorAppCameraEnabled": true,
            "crmall": {
                "url": "https://crmall4c.crmall.com/api",
                "credentials": "H4gLtHQN0Foo5SYbUwlhFOOzIHPOEuyTGcq5hIBfoojj5RT68Wkr",
                "underMaintenance": false
            },
            "baseUnica": {
                "url": "https://able-rubric.com/",
                "credentials": "commodo aute magna tempor dolor"
            },
            "inputTypes": [
                "nfe",
                "nfe",
                "token"
            ],
            "prizorKioskUnlockByTouch": "fullService",
            "prizorKioskUnlockByQRCode": "disabled"
        },
        {
            "id": 1234,
            "title": "Campanha Mães 2025",
            "hashtag": "maes2025",
            "campaignBanner": "ea",
            "startDate": "2025-12-25T00:00:00-03:00",
            "endDate": "2025-12-30T00:00:00-03:00",
            "partnerId": 1234,
            "partnerName": "Parceiro Ltda",
            "partnerCity": "Maringá",
            "partnerState": "PR",
            "partnerLatitude": "-22.98495",
            "partnerLongitude": "-47.040916",
            "partnerLogo": "https://avatars.githubusercontent.com/u/56928421",
            "distance": "incididunt eu",
            "participating": true,
            "sentInvoice": null,
            "ended": true,
            "isCampaignTest": true,
            "typeEnum": 19,
            "type": [
                "unique_bid",
                "prizeGiving",
                "hint"
            ],
            "inputTypesEnum": 92,
            "prizorGreenButton": true,
            "exclusiveFilters": [
                "aute ipsum velit",
                "minim ex"
            ],
            "prizorAppCameraEnabled": false,
            "crmall": {
                "url": "https://crmall4c.crmall.com/api",
                "credentials": "H4gLtHQN0Foo5SYbUwlhFOOzIHPOEuyTGcq5hIBfoojj5RT68Wkr",
                "underMaintenance": true
            },
            "baseUnica": {
                "url": "https://quarrelsome-someplace.us/",
                "credentials": "mollit"
            },
            "inputTypes": [
                "token"
            ],
            "prizorKioskUnlockByTouch": "fullService",
            "prizorKioskUnlockByQRCode": "enabled"
        }
    ]
}