microCMS

GET /api/v1/members/{member_id}

This is an API that allows you to retrieve detailed information about any member.

Request Header

X-MICROCMS-API-KEY

This is the authentication key required for GET API requests.
Please enable the "Get Members (List & Details)" permission in the Management API and include it in the request header when sending.

cautionCaution

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)".

Path Parameters

member_id

Please specify the ID of the member to retrieve.
The ID can be found in the member detail screen of the management interface or in the responses of various management APIs.

Response Body

This is an example of a member detail response when successfully retrieved.

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

The response includes the following data.

Value

Description

id

The member's ID.

name

The member's display name. If not set, it will be an empty string ("").

email

The member's email address.

mfa

Whether two-factor authentication is enabled. (true: enabled, false: disabled)