GET/v1/subscribers

Listar assinantes

Lista os assinantes do site, do mais recente para o mais antigo, com paginação por número de página. Endpoint de push, chaves e IP nunca aparecem na resposta.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenchaveSecretaoptional

Stored only in this browser for the chaveSecreta security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

tagquery · stringoptional

Retorna só assinantes que têm esta tag.

external_idquery · stringoptional

Retorna só o assinante com este external_id (comparação exata). Como o external_id é único no site, a lista vem com um item ou vazia.

per_pagequery · integeroptional

Itens por página. Padrão 50; valores fora de 1 a 100 são ajustados para o limite mais próximo.

pagequery · integeroptional

Número da página, começando em 1.

Responses

200application/json

Página de assinantes.

{
  "data": [
    {
      "id": "0199b2d4-6f1e-7c3a-9b1e-2f4a8c6d0e11",
      "external_id": "user-42",
      "tags": [
        "vip",
        "newsletter"
      ],
      "active_devices": 2,
      "created_at": "2026-09-28T14:03:11+00:00"
    }
  ],
  "links": {
    "first": "https://api.pushwi.com/v1/subscribers?tag=vip&page=1",
    "last": "https://api.pushwi.com/v1/subscribers?tag=vip&page=37",
    "prev": null,
    "next": "https://api.pushwi.com/v1/subscribers?tag=vip&page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 37,
    "path": "https://api.pushwi.com/v1/subscribers",
    "per_page": 50,
    "to": 50,
    "total": 1843
  }
}

dataarray<>optional

linksoptional

Links prontos para outras páginas. Repetem os parâmetros da requisição (tag, external_id, per_page).

metaoptional

401application/json

Chave ausente, inválida ou revogada.

{
  "message": "Credencial ausente ou inválida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.