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

API Docs

listAdmins

GET

/v1/admins

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

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Queryパラメータ

page

integer

可選

ページ番号を指定します。

サンプル値:

page_size

integer

可選

1ページに含まれるレコードの数を指定します。0-100を指定可能、指定しない場合は100となります。

サンプル値:

100

last_name

string

可選

last_nameでフィルターできます。日本語を含む場合はURLエンコードした値を利用してください。

サンプル値:

Kurosu

first_name

string

可選

first_nameでフィルターできます。日本語を含む場合はURLエンコードした値を利用してください。

サンプル値:

Taro

string

可選

emailでフィルターできます。日本語を含む場合はURLエンコードした値を利用してください。

サンプル値:

t-kurosu@example.com

role_type

string

可選

role_typeでフィルターできます。
数字に対応するロールのタイプは以下のとおりです。
1: オーナー
2: 承認者
3: メンバー
4: カスタムロール

サンプル値:

custom_role_ids

string

可選

カスタムロールのIDでフィルターできます。複数指定する場合は、カンマ区切りで指定します。

サンプル値:

00000000-0000-0000-0000-102101ec7001,00000000-0000-0000-0000-102101ec7002

group_ids

string

可選

グループのIDでフィルターできます。複数指定する場合は、カンマ区切りで指定します。

サンプル値:

00000000-0000-0000-0000-102101ec7001,00000000-0000-0000-0000-102101ec7002

created_at_from

integer

可選

この時刻以後のcreated_atを持つ管理者でフィルターできます。
UNIX時間で指定します。

サンプル値:

1735657200

created_at_to

integer

可選

この時刻以前のcreated_atを持つ管理者でフィルターできます。
UNIX時間で指定します。

サンプル値:

1735743599

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

Basic認証を利用します。値にはBasicの後にスペースとBase64でエンコードされた{API key ID}:{API key secret}を利用します。

サンプル値:

Basic QVBJa2V5SUQ6QVBJa2V5c2VjcmV0

Host

string

必須

UAT環境をご利用の場合はmanagement-api-uat.smartpost.jpを指定してください。

サンプル値:

User-Agent

string

必須

サンプル値:

Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://management-api.smartpost.jp/v1/admins?page=1&page_size=100&last_name=Kurosu&first_name=Taro&email=t-kurosu@example.com&role_type=1&custom_role_ids=00000000-0000-0000-0000-102101ec7001,00000000-0000-0000-0000-102101ec7002&group_ids=00000000-0000-0000-0000-102101ec7001,00000000-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 Og=='

Response

🟢200Success

application/json

Body

pagination

object (Pagination_update)

必須

レスポンスのページネーションに関する情報です。

page

integer

必須

レスポンスのページ番号です。

サンプル値:

page_size

integer

必須

1ページに含まれるレコード数です。

サンプル値:

total_records

integer

必須

全レコード数です。

サンプル値:

filter

object (AdminFilter)

可選

last_name

string

可選

フィルター条件に利用された値です。

サンプル値:

Kurosu

first_name

string

可選

フィルター条件に利用された値です。

サンプル値:

Taro

string <email>

可選

フィルター条件に利用された値です。

サンプル値:

t-kurosu@example.com

role_type

integer

可選

フィルター条件に利用された値です。

サンプル値:

group_ids

string

可選

フィルター条件に利用された値です。

サンプル値:

00000000-0000-0000-0000-acc000000001,00000000-0000-0000-0000-acc000000002

created_at_from

integer

可選

フィルター条件に利用された値です。

サンプル値:

1667899934

created_at_to

integer

可選

フィルター条件に利用された値です。

サンプル値:

1667899934

data

array [object {18}]

必須

管理者の情報です。

string

必須

管理者の識別子です。

サンプル値:

00000000-0000-0000-0000-ad1110000001

account_id

string

必須

管理者が属するアカウントの識別子です。

サンプル値:

00000000-0000-0000-0000-acc000000001

string <email>

必須

管理者のメールアドレスです。

サンプル値:

t-kurosu@example.com

last_name

string

必須

管理者の姓です。

<= 100 文字列

サンプル値:

Kurosu

first_name

string

可選

管理者の名です。

<= 100 文字列

サンプル値:

Taro

status

integer

必須

管理者の招待ステータスに対応した数字です。
数字に対応する招待ステータスは以下のとおりです。
1: 登録済み（初回ログイン済み）
2: 招待中

サンプル値:

login_at

integer

可選

最後にログインした時刻（UNIX時間）です。

サンプル値:

1667899934

invited_by

string

必須

招待した管理者の識別子です。

サンプル値:

00000000-0000-0000-0000-ad1110000000

created_at

integer

必須

最初に招待された時刻（UNIX時間）です。

サンプル値:

1667899934

updated_by

string

可選

最後に更新した管理者の識別子です。

サンプル値:

00000000-0000-0000-0000-ad1110000000

updated_at

integer

可選

最後に更新した時刻（UNIX時間）です。

サンプル値:

1667899934

is_disabled

boolean

必須

管理者の無効化ステータスです。現在はSmartPOST運営者のみがこのステータスを変更可能です。
true: 無効
false: 有効

サンプル値:

false

role_name

string

必須

管理者に設定されたロール（カスタムロール）名です。

サンプル値:

オーナー

groups

array [object {2}]

可選

管理者に設定されたグループです。

group_names

array[string]

可選

サンプル値:

["sample group name 1","sample group name 2","sample group name 3"]

prefecture

string

可選

管理者の属するアカウントの都道府県名です。

サンプル値:

黒須県

city

string

可選

管理者の属するアカウントの市区町村名です。

サンプル値:

黒須市

xid_connected

boolean

必須

xID連携のステータスです。
true: xID連携済み
false: xID未連携

サンプル値:

true

例

{
    "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

listProjectVariables

getAdmin