招待を一覧表示する

GET /v1/invitations · 権限 invitations:read

この環境の招待を、古いものから順に一覧表示します。前方向のページネーションのみサポートされています。フィルターは organization_id、email（完全一致）、status です。カーソルはフィルターに紐づけられ、メールアドレスはキー付きハッシュとしてのみカーソルに含まれます。承諾リンクは一覧に含まれることはありません。

リクエスト

項目 型 必須 説明
limit query いいえ 1〜100。既定値は 20。
after query いいえ list_metadata.after から取得したカーソル。
organization_id query いいえ 組織 ID（org_…）。
email query いいえ メールアドレス（完全一致）。
status query いいえ pending、accepted、revoked、expired のいずれか。

リクエストボディはありません。

レスポンス

200 OK で、招待のページを返します。

{
  "data": [
    {
      "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
      "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
      "email": "ada@example.com",
      "role_ids": [
        "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
      ],
      "application_id": null,
      "delivery": "link_only",
      "delivery_status": "not_sent",
      "status": "pending",
      "send_count": 1,
      "last_sent_at": "2026-10-12T09:31:00.123456Z",
      "expires_at": "2026-10-19T09:31:00.123456Z",
      "accepted_user_id": null,
      "accepted_at": null,
      "revoked_at": null,
      "created_at": "2026-10-12T09:31:00.123456Z",
      "updated_at": "2026-10-12T09:31:00.123456Z",
      "version": 1
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

エラー

HTTP code 発生条件
400 invalid_cursor カーソルが無効か、別のフィルターに属しています。
422 validation_failed フィルターまたは limit が無効か、before または asc 以外の order が指定されました。
401 unauthenticated 認証情報が見つからないか、無効または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

curl -i "https://api.eu.keenauth.com/v1/invitations?organization_id=org_01j9xk3m7q8r2s4t6v8w0y2z4a&status=pending" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは、組織のメンバーシップと招待に関する個人データを扱います。KeenAuth API における個人データでは、保存される内容、保持期間、削除方法を説明しています。いずれの項目にも、特別な種類の個人データ（健康、生体認証データ、宗教、政治的意見、性的指向）を送信しないでください。