listProjectRecipients

GET

/v1/projects/{id}/recipients

listProjectsで取得したプロジェクトのIDを使用して本エンドポイントにリクエストを送ることで、プロジェクトの受信者情報を取得できます。受信者情報にはカスタム変数の値も含まれます。

リクエストパラメータ

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/projects/00000000-0000-0000-0000-acc000000001/recipients?page=1&page_size=100&read_status=3&name=%E9%BB%92%E9%A0%88%20%E5%A4%AA%E9%83%8E&prefecture=%E6%9D%B1%E4%BA%AC%E9%83%BD&city=%E5%8D%83%E4%BB%A3%E7%94%B0%E5%8C%BA&address=%E5%86%85%E5%B9%B8%E7%94%BA%EF%BC%92%E4%B8%81%E7%9B%AE&dob_from=1980-01-01&dob_to=1980-12-31&gender=1&listed_at_from=1735657200&listed_at_to=1735743599&read_at_from=1735657200&read_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

例

{
    "message": "Not Found"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

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

listImageUrls

listProjectVariables