API legada/Referência completa/Assinantes da newsletter

Consultar assinante

Retorna um assinante da newsletter pelo UUID.

Retorna um assinante pelo UUID. Use para conferir a situação de uma inscrição que você acabou de criar ou para confirmar um cancelamento.

GET/api/v1.0/subscribers/{id}Admin

Consultar um assinante

Parâmetros de caminho

iduuidobrigatório

Id do assinante (UUID), como devolvido em subscriber_id por /api/v1.0/subscribers. O id decimal da forma /api/... não é aceito.

GET/api/subscribers/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/subscribers/{id}. Use este caminho se o seu cliente já foi escrito para ele. Nesta forma sem versão o subscriber_id sai como número decimal em string, mas o caminho /{id} só aceita o UUID.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/subscribers/43053e7f-c17b-4c8a-8009-649f1c0cef85" \
  -u "$EMAIL:$API_KEY"

Resposta

200Assinante encontrado

json

{
  "subscriber_id": "43053e7f-c17b-4c8a-8009-649f1c0cef85",
  "email": "maria.souza@example.com",
  "name": "Maria Souza",
  "status": "A",
  "timestamp": 1791753743
}

Campos da resposta

subscriber_idstring

Id do assinante (UUID em /api/v1.0; decimal em string em /api).

emailstring

E-mail inscrito. A rota não valida o formato.

namestring

Nome informado. Vazio quando não há.

statusstring

APUB

Situação: A ativo, P pendente de confirmação (a loja usa confirmação em duas etapas), U cancelou a inscrição, B suprimido por bounce.

timestampinteger

Data de criação do registro em Unix timestamp (segundos, UTC).

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}`
401	E-mail ou chave de API inválidos.	`{"status":401,"message":"Invalid credentials"}`
403	A credencial é válida, mas o usuário não é administrador.	`{"status":403,"message":"Forbidden: admin scope required"}`
500	Não existe assinante com esse UUID, ou o id não tem formato de UUID. Deveria ser 404; é uma falha conhecida.	`{"status":500,"message":"Failed to get subscriber: subscriber not found"}`

Veja também