Pular para o conteúdo
Entrar Lista de espera
Docs/Referência da API/Avisos/Listar avisos do painel

Listar avisos do painel

GET /v1/notifications escopo read

A central de avisos (o sino) de quem está logado neste workspace, do mais novo para o mais antigo: notifications (id, event = postSent, postFailed, scheduledFail, weeklySummary ou newComment, data com os fatos do evento, link para onde ele leva, read, readAt e createdAt), unreadCount e next. O aviso só existe se a preferência panel daquele evento estava ligada quando ele aconteceu. Filtros: unread (true), limit (1 a 50, padrão 20) e cursor (o next da página anterior). Guardados por 30 dias. Uma chave de API não tem usuário e lê uma lista vazia.

CabeçalhosAuthorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.

Parâmetros

Nome Onde Descrição
unread consulta true devolve só os não lidos.
limit consulta Itens por página (1 a 50). Padrão: 20.
cursor consulta O next da página anterior.

Exemplo

curl "https://praeko.app/v1/notifications" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"

Resposta

Status de sucesso Quando
200 Sucesso.
Resposta 200
{
  "notifications": [
    {
      "id": "01KA3ZB6T8N2QW5XH0D7MV4CRE",
      "event": "postFailed",
      "data": {
        "event": "post.failed",
        "title": "O teste que só falhava na segunda",
        "network": "youtube",
        "error": "o YouTube recusou o vídeo (quota diária excedida)",
        "postId": "01KA3W2Y6H1RC5ZQ8M0T4VXE7N"
      },
      "link": {
        "type": "post",
        "id": "01KA3W2Y6H1RC5ZQ8M0T4VXE7N"
      },
      "read": false,
      "createdAt": "2026-11-07T14:02:11.482Z"
    },
    {
      "id": "01KA3Z5H2C9JR7TQ0M4XB8VNDF",
      "event": "newComment",
      "data": {
        "count": 3,
        "author": "Ana",
        "text": "Muito bom, qual editor você usa?",
        "videoId": "dQw4w9WgXcQ",
        "network": "youtube"
      },
      "link": {
        "type": "comments"
      },
      "read": true,
      "createdAt": "2026-11-07T14:02:11.482Z",
      "readAt": "2026-11-07T14:30:00.000Z"
    }
  ],
  "unreadCount": 1
}

Erros

Status code Quando
422 invalid_field limit fora de 1 a 50, unread que não é true/false ou cursor inválido.

Erros de qualquer rota

Status code Quando
401 unauthorized Faltou o cabeçalho Authorization: Bearer ….
401 invalid_api_key A chave não existe.
401 revoked_api_key A chave foi revogada.
401 expired_api_key A chave expirou.
403 forbidden O escopo da chave não basta para esta rota (veja o selo de escopo).
429 rate_limited Passou do limite de requisições por minuto.

O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.

Testar

Testar

O teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.

Entre para testar
Dúvida ou erro nesta página? contato@praeko.appVer .md

Digite para buscar páginas, rotas e códigos de erro.