This is an API that allows you to retrieve a list of members belonging to any service.
This is the authentication key required for GET API requests.
Enable “Retrieve Members (List and Details)” in the Management API permissions, and include it in the request headers when sending the request.
If the X-MICROCMS-API-KEY is identifiable, it may allow unauthorized manipulation of content by third parties. Please handle it with care. For more details, please refer to "API Key (API Authentication and Authorization Management)".
Example response for a successfully retrieved list of members.
{
"members": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "test-member",
"email": "test@microcms.co.jp",
"roleIds": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
"mfa": true,
"inviting": false,
"lastAccessedAt": "2026-01-01T00:00:00.000Z"
},
{
...
}
],
"totalCount": 120,
"token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}The response includes the following data.
An array of members. Each member object contains the following data.
Invited members are not included in the response.
Value | Description |
|---|---|
| The member's ID. |
| The member's display name. If not set, this is an empty string ( |
| The member's email address. |
| An array of Role IDs assigned to the member. Each ID corresponds to the |
| Whether Two-Factor authentication is enabled ( |
| Whether the member is being invited ( |
| The date and time of the member's last access to the Service's Administration console (UTC in ISO 8601 format). ・The Service's Plan is not the Enterprise plan |
The total number of members who have joined. Members who have been invited are not included.
The token used for pagination. It is returned when another page is available.
To retrieve the next page of data, specify this value in the token query parameter of the next request.
Please specify the number of members to retrieve.
0-10010Please specify the token to be used for pagination.
By specifying the value of token included in the response in the next request, you can retrieve the subsequent data.