GET /api/v1/members/{member_id}

最終更新日:2025年08月12日

任意のメンバーの詳細情報を取得できるAPIです。

リクエストヘッダー

GET APIリクエストの際に必要な認証キーです。
マネジメントAPIの権限で「メンバー詳細情報の取得」を有効にして、リクエストヘッダーに含めて送信してください。

Caution: X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。

取得するメンバーのIDを指定してください。
IDは管理画面のメンバー詳細画面や、各種マネジメントAPIのレスポンスの中で、確認可能です。

ステータスコード	エラーメッセージ	原因と対策
200	-	-
403	Forbidden	メンバー詳細情報の取得が許可されていません。APIキー設定で権限が付与されていることを確認してください。
404	Member not found	取得しようとしたメンバーが存在していない、もしくは招待中です。サービス参加済みのメンバーを指定してください。
429	Too Many Requests	マネジメントAPIのレートリミットを超過しています。リクエスト間隔を空けて、リトライしてください。

正常に取得できた場合の、メンバー詳細のレスポンス例です。

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "name": "test-member",
  "email": "test@microcms.co.jp",
  "mfa": true
}

レスポンスには以下のデータが含まれます。

値	説明
`id`	メンバーのIDです。
`name`	メンバーの表示名です。未設定の場合は、空の文字列（`""`）となります。
`email`	メンバーのメールアドレスです。
`mfa`	二要素認証の設定の有無です。（`true`：有効、`false`：無効）