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

API Docs

listProjects

GET

/v1/projects

このエンドポイントを使用することで、プロジェクト（テンプレート、Welcome プロジェクト）の一覧を取得できます。

情報

テンプレート、Welcome プロジェクトについて一覧を取得するには、typeを指定してリクエストしてください。

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

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

例：

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

Queryパラメータ

page

integer

可選

ページ番号を指定できます。

サンプル値:

page_size

integer

可選

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

サンプル値:

100

title

string

可選

プロジェクトのタイトルでフィルターできます。

サンプル値:

project title

message_title

string

可選

メッセージのタイトルでフィルターできます。

サンプル値:

message title

schedule_from

integer

可選

この時刻以後のscheduleを持つプロジェクトでフィルターできます。
UNIX時間で指定します。

サンプル値:

1735657200

schedule_to

integer

可選

この時刻以前のscheduleを持つプロジェクトでフィルターできます。
UNIX時間で指定します。

サンプル値:

1735743599

created_by

string

可選

作成者(管理者)のIDでフィルターできます。

サンプル値:

00000000-0000-0000-0000-102101ec7001

created_at_from

integer

可選

この時刻以後のcreated_atを持つプロジェクトでフィルターできます。
UNIX時間で指定します。

サンプル値:

1735657200

created_at_to

integer

可選

この時刻以前のcreated_atを持つプロジェクトでフィルターできます。
UNIX時間で指定します。

サンプル値:

1735743599

categories

string

可選

プロジェクトのcategoriesでフィルターできます。複数指定する場合は、カンマ区切りで指定します。
数字に対応するメッセージカテゴリーは以下のとおりです。
1: 給付金、補助金
2: 健康、医療
3: 学校、教育
4: 税金
5: 環境
6: 高齢者支援
7: 上下水道
8: 防災、地域安全
9: 選挙
10: 産業
11: 観光
12: 建築
13: 道路
14: 資源、ゴミ
15: 子育て、保育所
16: 生涯学習、図書館
17: 福祉、介護
18: 地域コミュニティ
19: 公共施設
20: 芸術、文化、スポーツ
21: 住民参画、意見募集
22: 個人宛通知
23: セグメント通知

サンプル値:

1,22

permitted_group_ids

string

可選

プロジェクトに設定されたpermitted_groups.idでフィルターできます。複数指定する場合は、カンマ区切りで指定します。

サンプル値:

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

type

string

可選

typeを指定します。次の文字列が許容されていますが、これら以外の値を入力した場合、また、パラメーターを指定しなかった場合はnormalとして取り扱われます。
normal: プロジェクト
welcome: Welcomeプロジェクト
template: テンプレート

サンプル値:

normal

Headerパラメータ

string

必須

サンプル値:

application/json

Authorization

string

必須

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

サンプル値:

Basic <Base64-encoded-credentials>

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?page=1&page_size=100&title=project title&message_title=message title&schedule_from=1735657200&schedule_to=1735743599&created_by=00000000-0000-0000-0000-102101ec7001&created_at_from=1735657200&created_at_to=1735743599&categories=1,22&permitted_group_ids=00000000-0000-0000-0000-102101ec7001,00000000-0000-0000-0000-102101ec7002&type=normal' \
--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 (ProjectFilter)

可選

title

string

可選

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

サンプル値:

sample title

message_title

string

可選

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

サンプル値:

sample message title

schedule_from

integer

可選

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

サンプル値:

1667899934

schedule_to

integer

可選

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

サンプル値:

1667899934

created_by

string

可選

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

サンプル値:

00000000-0000-0000-0000-acc000000001

created_at_from

integer

可選

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

サンプル値:

1667899934

created_at_to

integer

可選

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

サンプル値:

1667899934

status

integer

可選

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

サンプル値:

categories

array[integer]

可選

設定されたメッセージカテゴリーに対応した数字の配列が返されます。
数字に対応するメッセージカテゴリーは以下のとおりです。
1: 給付金、補助金
2: 健康、医療
3: 学校、教育
4: 税金
5: 環境
6: 高齢者支援
7: 上下水道
8: 防災、地域安全
9: 選挙
10: 産業
11: 観光
12: 建築
13: 道路
14: 資源、ゴミ
15: 子育て、保育所
16: 生涯学習、図書館
17: 福祉、介護
18: 地域コミュニティ
19: 公共施設
20: 芸術、文化、スポーツ
21: 住民参画、意見募集
22: 個人宛通知
23: セグメント通知

permitted_groups

array [object {2}]

可選

グループ権限で設定されたグループです。

例

{
    "pagination": {
        "page": 1,
        "page_size": 20,
        "total_records": 32
    },
    "filter": {
        "title": "sample title",
        "message_title": "sample message title",
        "schedule_from": 1667899934,
        "schedule_to": 1667899934,
        "created_by": "00000000-0000-0000-0000-acc000000001",
        "created_at_from": 1667899934,
        "created_at_to": 1667899934,
        "status": 1,
        "categories": "1",
        "permitted_group_ids": "00000000-0000-0000-0000-acc000000001,00000000-0000-0000-0000-acc000000002",
        "type": "normal"
    },
    "data": [
        {
            "id": "00000000-0000-0000-0000-acc000000001",
            "account_id": "00000000-0000-0000-0000-acc000000001",
            "title": "sample title",
            "message_title": "sample message title",
            "schedule": 1667899934,
            "created_by": "00000000-0000-0000-0000-acc000000001",
            "created_at": 1667899934,
            "sent_to_all_recipients_at": 1667899934,
            "categories": [
                1
            ],
            "permitted_groups": [
                {
                    "id": "00000000-0000-0000-0000-acc000000001",
                    "name": "sample group"
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

用語定義

getProject