Entrar

Opt-out: Listar

GET https://{organization}.myguper.com/api/sender/opt-preference

Lista paginada de los registros de opt-out de la organización, más recientes primero.

Una fila por identificador, así que un cliente registrado con persona + correo + teléfono aparece en tres filas. Para preguntar por un cliente específico, use Consultar.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

Name Type Description
x-guper-authorization * string User token issued by Guper.
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 Page size, capped at 500.
por defecto: 50
p integer Page number.
por defecto: 1
target_type string
person | email | phone
Filter by identifier kind.
target string Exact identifier value. Phone is stored as country code + digits, e.g. `525512345678`.
person integer Person id kept as a reference on the row — including on e-mail and phone rows.
provider string Channel the record blocks (`all` or a provider slug).
type string
optout | optin
Stored state. In practice always `optout` — revoking deletes the row.
source string
link | reply | admin | api | provider | import | manual

Respuestas

[
  {
    "id": 41,
    "organization": "acme",
    "target_type": "email",
    "target": "cliente@exemplo.com",
    "provider": "all",
    "scope": "all",
    "type": "optout",
    "source": "admin",
    "actor": "maria@lojista.com",
    "detail": "pediu por telefone no SAC",
    "person": 184532,
    "createdAt": "2026-09-02 10:14:03",
    "updatedAt": "2026-09-02 10:14:03"
  }
]

Relacionados

Copied to clipboard