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

API Docs

listProjectRecipients

GET

/v1/projects/{id}/recipients

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

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Pathパラメータ

string

必須

プロジェクトのIDを指定します。

サンプル値:

00000000-0000-0000-0000-acc000000001

Queryパラメータ

page

integer

可選

ページ番号を指定できます。指定しない場合は1となります。

サンプル値:

page_size

integer

可選

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

サンプル値:

100

read_status

integer

可選

read_statusでフィルターできます。
1: 送信済み
2: 未読
3: 既読
4: 削除済み
5: 送信不可

サンプル値:

name

string

可選

last_name first_nameに対してフィルターできます。どちらも入力する場合は半角スペースで区切ります（AND条件でフィルターされます）。
※サンプル値は「黒須太郎」をURIエンコードしたものです。

サンプル値:

%E9%BB%92%E9%A0%88%20%E5%A4%AA%E9%83%8E

prefecture

string

可選

prefectureでフィルターできます。
※サンプル値は「東京都」をURIエンコードしたものです。

サンプル値:

%E6%9D%B1%E4%BA%AC%E9%83%BD

city

string

可選

cityでフィルターできます。
※サンプル値は「千代田区」をURIエンコードしたものです。

サンプル値:

%E5%8D%83%E4%BB%A3%E7%94%B0%E5%8C%BA

address

string

可選

addressでフィルターできます。
※サンプル値は「内幸町２丁目」をURIエンコードしたものです。

サンプル値:

%E5%86%85%E5%B9%B8%E7%94%BA%EF%BC%92%E4%B8%81%E7%9B%AE

dob_from

string

可選

この日以後のdate_of_birthを持つ受信者でフィルターできます。
yyyy-MM-ddのフォーマットで指定します。

サンプル値:

1980-01-01

dob_to

string

可選

この日以前のdate_of_birthを持つ受信者でフィルターできます。
yyyy-MM-ddのフォーマットで指定します。

サンプル値:

1980-12-31

gender

integer

可選

受信者の性別に紐づく数字でフィルターできます。
1: 男性
2: 女性

サンプル値:

listed_at_from

integer

可選

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

サンプル値:

1735657200

listed_at_to

integer

可選

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

サンプル値:

1735743599

read_at_from

integer

可選

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

サンプル値:

1735657200

read_at_to

integer

可選

この時刻以前のread_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/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 Og=='

Response

🟢200Success

application/json

Body

pagination

object (Pagination_update)

必須

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

page

integer

必須

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

サンプル値:

page_size

integer

必須

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

サンプル値:

total_records

integer

必須

全レコード数です。

サンプル値:

filter

object (ProjectRecipientFilter)

可選

read_status

integer

可選

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

サンプル値:

name

string

可選

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

サンプル値:

黒須太郎

gender

integer

可選

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

サンプル値:

dob_from

string

可選

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

サンプル値:

1982-01-01

dob_to

string

可選

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

サンプル値:

1982-01-01

prefecture

string

可選

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

サンプル値:

東京都

city

string

可選

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

サンプル値:

千代田区

address

string

可選

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

サンプル値:

内幸町２丁目

listed_at_from

integer

可選

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

サンプル値:

1667899934

listed_at_to

integer

可選

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

サンプル値:

1667899934

read_at_from

integer

可選

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

サンプル値:

1667899934

read_at_to

integer

可選

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

サンプル値:

1667899934

data

array [object {16}]

可選

プロジェクトの受信者の情報です。

string

必須

受信者の識別子です。受信者として設定された利用者はプロジェクト毎に一意の受信者IDを持ちます。

サンプル値:

00000000-0000-0000-0000-121c1101e001

smartpost_user_id

string

必須

受信者として設定されている利用者のSmartPOST利用者IDです。

サンプル値:

00000000-0000-0000-0000-acc000000001

sent_at

integer

可選

受信者にメッセージが通知された時刻（UNIX時間）です。
プッシュ通知時刻ではなく、デジタル郵便受けでメッセージが確認できるようになった時刻を意味します。

サンプル値:

1667899934

listed_at

integer

可選

受信者がメッセージをリスト（一覧表示）した時刻（UNIX時間）です。

サンプル値:

1667899934

read_at

integer

可選

受信者がメッセージを開いた時刻（UNIX時間）です。

サンプル値:

1667795460

read_status

integer

必須

受信者の既読ステータスに対応した数字です。
数字に対応する受信者の既読ステータスは以下のとおりです。
1: 送信済（まだリスト表示もされていない状態）
2: 未読（リスト表示はしたが、メッセージを開いてはいない状態）
3: 既読
4: 削除済
5: 送信不可
6: 未送信

サンプル値:

first_name

string

必須

受信者の姓です。

サンプル値:

黒須

last_name

string

必須

受信者の名です。

サンプル値:

太郎

gender

integer

必須

受信者の性別に対応した数字です。
数字に対応する性別は以下のとおりです。
1: 男性
2: 女性

サンプル値:

date_of_birth

string

必須

受信者の生年月日です。YYYY-MM-DDの形式で返されます。

prefecture

string

必須

受信者の住所「都道府県」です。

サンプル値:

東京都

city

string

必須

受信者の住所「市区町村」です。

サンプル値:

千代田区

address

string

必須

受信者の住所「番地等」です。

サンプル値:

内幸町２丁目１－６

subscribed_at

integer

必須

受信者として設定されている利用者の登録日時（UNIX時間）です。

サンプル値:

1667795458

is_active_user

boolean

必須

受信者として設定されている利用者のアクティブ状況(無効化フラグの状況)です。
true: 有効（無効化フラグオフ）
false: 無効（無効化フラグオン）

vars

array [object {3}]

可選

受信者に設定されているカスタム変数です。

例

{
    "message": "Not Found"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found

listImageUrls

listProjectVariables