Ir para o conteúdo

Obter todas as mensagens GET ​

Recupere uma lista de todas as mensagens da sua conta.

Endpoint ​

GET https://api.pocketalert.app/v1/messages

Autenticação ​

Obrigatório

Inclua um destes cabeçalhos na sua requisição:

  • Token: <your-api-key> — Obtenha em Chaves de API
  • Authorization: Bearer <jwt-token> — De Login

Requisição ​

Cabeçalhos ​

CabeçalhoObrigatórioDescrição
Token✅Sua chave de API
Authorization✅Bearer <jwt-token>

Parâmetros de consulta ​

ParâmetroTipoPadrãoDescrição
sortstringdescOrdem de classificação pela data de criação (asc ou desc)
limitinteger50Número máximo de mensagens a retornar

Exemplo de requisição ​

bash
curl -X GET "https://api.pocketalert.app/v1/messages?sort=desc&limit=10" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/messages?sort=desc&limit=10', {
  headers: { 'Token': 'your-api-key' }
});
const messages = await response.json();
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/messages',
    headers={'Token': 'your-api-key'},
    params={'sort': 'desc', 'limit': 10}
)
print(response.json())
php
$response = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/messages', [
    'sort' => 'desc',
    'limit' => 10,
]);

return $response->json();

Resposta ​

Resposta de sucesso ​

200 OK

Retorna um array de objetos de mensagem

CampoTipoDescrição
tidstringIdentificador único da mensagem
titlestringTítulo da mensagem
messagestringCorpo da mensagem
applicationstringNome do aplicativo
devicestringDispositivo de destino
is_readbooleanSe a mensagem foi lida
created_atstringData e hora de criação
json
[
  {
    "tid": "jb4xw9elz24c5",
    "title": "Server Alert",
    "message": "CPU usage exceeded 90%",
    "application": "Monitoring",
    "device": "iPhone",
    "is_read": true,
    "created_at": "18.09.2023 17:35:35"
  },
  {
    "tid": "d4u21qej1hld",
    "title": "Deploy Complete",
    "message": "Version 2.1.0 deployed",
    "application": "CI/CD",
    "device": "iPhone",
    "is_read": false,
    "created_at": "18.09.2023 17:35:23"
  }
]

Respostas de erro ​

StatusDescrição
401Não autorizado — token inválido ou ausente

Documentação do Pocket Alert