listAdmins

GET

/v1/admins

このエンドポイントを使用することで、管理者の一覧を取得できます。

リクエストパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

クエリパラメータ

Headerパラメータ

リクエストコードサンプル

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://management-api.smartpost.jp/v1/admins?page=1&page_size=100&last_name=Kurosu&first_name=Taro&email=t-kurosu%40example.com&role_type=1&custom_role_ids=00000000-0000-0000-0000-102101ec7001%2C00000000-0000-0000-0000-102101ec7002&group_ids=00000000-0000-0000-0000-102101ec7001%2C00000000-0000-0000-0000-102101ec7002&created_at_from=1735657200&created_at_to=1735743599' \
--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 <encoded-value>'

レスポンス

🟢200Success

application/json

ボディapplication/json

例

{
    "pagination": {
        "page": 1,
        "page_size": 20,
        "total_records": 32
    },
    "filter": {
        "last_name": "Kurosu",
        "first_name": "Taro",
        "email": "t-kurosu@example.com",
        "role_type": 1,
        "group_ids": "00000000-0000-0000-0000-acc000000001,00000000-0000-0000-0000-acc000000002",
        "created_at_from": 1667899934,
        "created_at_to": 1667899934
    },
    "data": [
        {
            "id": "00000000-0000-0000-0000-ad1110000001",
            "account_id": "00000000-0000-0000-0000-acc000000001",
            "email": "t-kurosu@example.com",
            "last_name": "Kurosu",
            "first_name": "Taro",
            "status": 1,
            "login_at": 1667899934,
            "invited_by": "00000000-0000-0000-0000-ad1110000000",
            "created_at": 1667899934,
            "updated_by": "00000000-0000-0000-0000-ad1110000000",
            "updated_at": 1667899934,
            "is_disabled": false,
            "role_name": "オーナー",
            "groups": [
                {
                    "id": "00000000-0000-0000-0000-acc000000001",
                    "name": "sample group name"
                }
            ],
            "group_names": [
                "sample group name 1",
                "sample group name 2",
                "sample group name 3"
            ],
            "prefecture": "黒須県",
            "city": "黒須市",
            "xid_connected": "true"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

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

listProjectVariables

getAdmin