トップ
マネジメントAPI （ベータ）

GET /api/v1/members

最終更新日: 2026/04/01

任意のサービスに所属しているメンバーの一覧を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

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

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

レスポンスボディ

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

{
  "members": [
    {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "test-member",
      "email": "test@microcms.co.jp",
      "mfa": true,
      "inviting": false
    },
    {
    ...
    }
  ],
  "totalCount": 120,
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

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

members

メンバーの配列です。各メンバーオブジェクトには以下のデータが含まれます。
招待中のメンバーはレスポンスに含まれません。

値	説明
`id`	メンバーのIDです。
`name`	メンバーの表示名です。未設定の場合は、空の文字列（`""`）となります。
`email`	メンバーのメールアドレスです。
`mfa`	二要素認証の設定の有無です。（`true`：有効、`false`：無効）SAMLユーザーの場合は `false` となります。
`inviting`	招待中かどうかを示します。（`true`：招待中、`false`：参加済み）現時点では必ず `false` となります。

totalCount

メンバーの全件数です。

token

ページネーションに利用するトークンです。次のページが存在する場合に返されます。
次のリクエストのクエリパラメータ token にこの値を指定することで、続きのデータを取得できます。

クエリパラメータ

limit

取得するメンバーの件数を指定してください。

指定可能な値: 0〜100
デフォルト値: 10

token

ページネーションに利用するトークンを指定してください。
レスポンスに含まれる token の値を次のリクエストに指定することで、続きのデータを取得できます。

リクエストヘッダー
X-MICROCMS-API-KEY
レスポンスボディ
members
totalCount
token
クエリパラメータ
limit
token