Entrar

Listar campañas

GET https://{organization}.myguper.com/api/loyalty/campaign

Lista paginada de las campañas de fidelidad/cashback. Filtra por nombre, disparador o tipo mediante la gramática común de listado. Devuelve la configuración de la campaña, no sus resultados — para tarjetas generadas, valor distribuido y canjeado, usa el reporte de la campaña.

Cada fila trae un status derivado: active, draft, paused o finished. draft es la campaña guardada y aún no publicada (isDraft): nunca se ejecuta y prevalece sobre cualquier otro status. finished no es columna: en las campañas audience-list significa que el envío terminó (audience-status = finished); en todos los demás disparadores significa que la vigencia (finishAt) terminó. finished prevalece sobre isActive — una campaña con la vigencia vencida y aún encendida vuelve como finished. El status es solo lectura: nunca cambia isActive.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Encabezados

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parámetros de query

Name Type Description
q[column][operator] string Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table.
o[column] string Sort by column. Direction: `ASC`, `DESC`, `1` or `0`.
e integer Filas por página.
por defecto: 20
p integer Número de página.
por defecto: 1
status string
active | draft | paused | finished
Solo las campañas en ese status derivado. Uno de `active`, `draft`, `paused`, `finished`.
statusCounts integer Con `1`, la respuesta agrega `statusCounts` (`{active, draft, paused, finished}`), calculado con los mismos filtros `q[...]` e ignorando `status`.
sortByStatus integer Con `1`, las activas van primero, luego los borradores, las pausadas y al final las terminadas; el orden solicitado aplica dentro de cada grupo.
q[field][OP] string Filtro estándar del Listing. `OP` es el código del operador (`S` exacto, `L` contiene, `IN`, ...).

Respuestas

Relacionados

Copied to clipboard