microCMS

GET /api/v1/service

This is an API that allows you to retrieve information about services. You can obtain the service name associated with a service ID.

Request Header

X-MICROCMS-API-KEY

This is the authentication key required for GET API requests to the Management API.
Please enable "Retrieve Service Information" with the default permissions of 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)".

Response Body

This is an example of the service information response when successfully retrieved.

{
    "name": "Test Service"
}


The response includes the following data.

Value

Type

Description

name

String

The service name will be entered here.