SmartPOSTの公開APIドキュメントです。

getGroup

GET

/v1/groups/{id}

listGroupsで取得したグループのIDを使用して本エンドポイントにリクエストを送ることで、グループの詳細情報を取得できます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBasicの後にスペースと、Base64でエンコードされたusername:passwordが連結されます

例：

Authorization: Basic *****************

Pathパラメータ

Headerパラメータ

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://management-api.smartpost.jp/v1/groups/00000000-0000-0000-0000-102101ec7001' \
--header 'Accept: application/json' \
--header 'Host: management-api.smartpost.jp' \
--header 'User-Agent: Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion' \
--header 'Authorization: Basic Og=='

Response

🟢200Success

application/json

Body

例

{
    "id": "00000000-0000-0000-0000-acc000000001",
    "account_id": "00000000-0000-0000-0000-acc000000001",
    "name": "sample group name",
    "description": "sample description",
    "created_by": "00000000-0000-0000-0000-acc000000001",
    "created_at": 1667899934,
    "custom_policy_id": "00000000-0000-0000-0000-acc000000001",
    "custom_policy_name": "sample custom policy name",
    "related_admins": [
        {
            "id": "00000000-0000-0000-0000-ad1110000001",
            "email": "t-kurosu@example.com",
            "last_name": "Kurosu",
            "first_name": "Taro",
            "status": 1,
            "is_disabled": false
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

更新日時 2025-03-27 01:11:41

listGroups

healthCheck