招待を取得する

GET /v1/invitations/{invitation_id} · 権限 invitations:read

承諾リンクを含まない招待を返します。取り消されたまたは期限切れの招待のメールアドレスは null になります。

リクエスト

項目 型 必須 説明
invitation_id path はい 招待 ID(inv_…)。

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

レスポンス

200 OK で、招待を返します。

{
  "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
}

エラー

HTTP code 発生条件
404 not_found 招待がこの環境に存在しません。
401 unauthenticated 認証情報が見つからないか、無効または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

curl -i "https://api.eu.keenauth.com/v1/invitations/inv_01j9xt9v3w4y8z0a2b4c6d8e0g" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

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