コンテンツへスキップ

全メッセージを取得 GET ​

アカウント内のすべてのメッセージの一覧を取得します。

エンドポイント ​

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

認証 ​

必須

リクエストに次のいずれかのヘッダーを含めてください。

  • Token: <your-api-key> — API キーから取得できます
  • Authorization: Bearer <jwt-token> — ログインから取得できます

リクエスト ​

ヘッダー ​

ヘッダー必須説明
Token✅API キー
Authorization✅Bearer <jwt-token>

クエリパラメーター ​

パラメーター型デフォルト説明
sortstringdesc作成日時による並び順(asc または desc)
limitinteger50取得するメッセージの最大件数

リクエストの例 ​

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();

レスポンス ​

成功時のレスポンス ​

200 OK

メッセージオブジェクトの配列を返します

フィールド型説明
tidstringメッセージの一意の識別子
titlestringメッセージのタイトル
messagestringメッセージの本文
applicationstringアプリケーション名
devicestring送信先のデバイス
is_readbooleanメッセージが既読かどうか
created_atstring作成日時
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"
  }
]

エラーレスポンス ​

ステータス説明
401認証されていません — トークンが無効または未指定です

Pocket Alert ドキュメント