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

listCustomPolicies

GET

/v1/custom-policies

このエンドポイントを使用することで、カスタムポリシーの一覧を取得できます。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Queryパラメータ

Headerパラメータ

サンプルコード

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://management-api.smartpost.jp/v1/custom-policies?keyword=sample policy&page=1&page_size=100' \
--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": {
        "page": 1,
        "page_size": 20,
        "total_records": 32
    },
    "filter": {
        "keyword": "sample keyword"
    },
    "data": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "account_id": "00000000-0000-0000-0000-acc000000001",
            "name": "sample custom policy name",
            "description": "sample description",
            "created_by": "00000000-0000-0000-0000-acc000000001",
            "created_at": 1667899934
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

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

getAdmin

getCustomPolicy