listProjects

GET

/v1/projects

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

情報

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

リクエストパラメータ

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?page=1&page_size=100&title=project%20title&message_title=message%20title&schedule_from=1735657200&schedule_to=1735743599&created_by=00000000-0000-0000-0000-102101ec7001&created_at_from=1735657200&created_at_to=1735743599&categories=1%2C22&permitted_group_ids=00000000-0000-0000-0000-102101ec7001%2C00000000-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 <encoded-value>'

レスポンス

🟢200Success

application/json

ボディapplication/json

例

{
    "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"
                }
            ],
            "pdf_ids": [
                {
                    "pdf_id": "00000000-0000-0000-0000-acc000000001_00000000-0000-0000-0000-acc000000002",
                    "file_name": "sample.pdf",
                    "is_individual_id": true
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

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

用語定義

getProject