GetSupporter

サポーター情報の取得

Description

外部からサポーター情報を取得

Method

GET

Request URL Format

/api/v1/supporters

Payload

Content-Type : application/json

Authorization : Bearer bbdf8d3b-ae12-4e63-93d8-d3a1c4254fc6

Request Parameter

パラメータ名	説明	補足
filter_date	日付の項目	（任意）フィルター項目を指定する（created_at、updated_at）、デフォルトはcreated_at
start_date	開始日	（必須）フィルターの開始日を指定する（yyyy-mm-dd形式）
end_date	終了日	（必須）フィルターの終了日を指定する（yyyy-mm-dd形式）
sort_item	並び順の項目	（任意）並び順の項目を指定する（created_at、updated_at）、デフォルトはcreated_at
sort_order	並び順の方向	（任意）並び順の方向を指定する（desc、asc）、デフォルトはdesc

Request URL Sample

GET https://global-api.congrant.com/api/v1/supporters?start_date=2023-05-16&end_date=2023-05-22&sort_item=created_at

Response Sample

{
    "status": true,
    "code": 200,
    "message": "サポーター情報取得に成功しました。",
    "data": [
        {
            "supporter": {
                "supporter_no": 2,
                "entity_type": "individual",
                "organization_name": "サンプル株式会社",
                "department_and_title": "マーケティング部 担当者",
                "last_name": "山田",
                "first_name": "太郎",
                "last_name_kana": "ヤマダ",
                "first_name_kana": "ダロウ",
                "pr_name_flg": "true",
                "email": "test@example.com",
                "email_distribution_type": "allowed",
                "phone_number": "080-5678-1234",
                "gender": "male",
                "birth_date": "1992-08-15",
                "send_flg": "true",
                "send_count": 10,
                "attribute": [
                    "属性1",
                    "属性2"
                ],
                "created_at": "2025-11-10 10:00:00",
                "updated_at": "2025-11-10 10:00:00",
            },
            "address": {
                "country": "日本",
                "postal_code": "150-0001",
                "prefecture": "東京都",
                "city": "渋谷区",
                "address_line": "神宮前1-2-3 サンプルマンション202"
            },
            "shipment_address": {
                "separate_address_flg": "true",
                "country": "日本",
                "postal_code": "150-0001",
                "prefecture": "東京都",
                "city": "渋谷区",
                "address_line": "神宮前1-2-3 サンプルマンション202",
                "organization_line": "神宮前1-2-3 サンプルマンション202",
                "recipient_name": "高田"
            },
            "custom_fields": [
                {
                    "id": 101,
                    "name": "設問1",
                    "value": [
                        "回答1"
                    ]
                },
                {
                    "id": 102,
                    "name": "設問2",
                    "value": [
                        "回答1",
                        "回答2"
                    ]
                }
            ],
            "payment": {
                "latest_paid_at": "2023-06-19",
                "total_payment_amount": 100000,
                "total_payment_count": 10
            }
        },
    ]
}

Response Explanation

• supporter - サポーター情報
  • supporter_no - サポーターNo
  • entity_type - サポーター種別。(個人:individual、法人:corporation)
  • organization_name - 法人名
  • department_and_title - 部署・肩書
  • last_name - 氏名（姓）
  • first_name - 氏名（名）
  • last_name_kana - 氏名（セイ）
  • first_name_kana - 氏名（メイ）
  • pr_name_flg - 広報物への掲載
  • email - メールアドレス
  • email_distribution_type - メール配信タイプ。(希望する:allowed、希望しない:disallowed、未回答:unanswered)
  • phone_number - 電話番号
  • gender - 性別。(男性:male、女性:female、その他:other、無回答:unanswered)
  • birth_date - 生年月日
• address - 住所情報
  • country - 国名
  • postal_code - 郵便番号
  • prefecture - 都道府県
  • city - 市区町村
  • address_line - 番地・建物
• shipment_address - 郵送先情報
  • separate_address_flg - 郵送先を別途指定
  • country - 国名
  • postal_code - 郵便番号
  • prefecture - 都道府県
  • city - 市区町村
  • address_line - 番地・建物
  • organization_line - 法人名・所属
  • recipient_name - 宛名
• custom_fields - カスタム項目
  • id - カスタム項目ID
  • name - カスタム項目名
  • value - カスタム項目回答
• payment - 決済履歴情報
  • latest_paid_at - 直近の決済日
  • total_payment_amount - 直近の決済額
  • total_payment_count - 累計決済金額