Skip to main content

GetProject

プロジェクト別寄付情報を取得

Description

プロジェクト別寄付情報(寄付者数、寄付額など)を取得

Method

GET

Request URL Format

/api/v1/projects

Payload

Content-Type : application/json

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

Request Parameter

パラメータ名説明補足
project_idプロジェクトID(任意)プロジェクトIDを指定する(配列で複数指定可。デフォルトはすべて)
project_typeプロジェクトタイプ(任意)プロジェクトタイプを指定する(basic/crowdfunding/monthly_funding/kifu_reter/event/other/bokin/campaign/item_funding)配列で複数指定可。デフォルトはすべて。
publish_status公開ステータス(任意)公開ステータスを指定する(public、limited)配列で複数指定可。デフォルトはpublic
fundraising_status募集ステータス(任意)募集ステータスを指定する(not_started、ongoing、finished)配列で複数指定可。デフォルトはongoing
sort_item並び順の項目(任意)並び順の項目を指定する(created_at、updated_at、start_date)、デフォルトはstart_date
sort_order並び順の方向(任意)並び順の方向を指定する(desc、asc)、デフォルトはasc

Request URL Sample

GET https://global-api.congrant.com/api/v1/projects?project_id[]=44&project_id[]=56

Response Sample

{
"status": true,
"code": 200,
"message": "プロジェクト情報取得に成功しました。",
"summary": {
"project_count": 2,
"cumulative_payment_amount": 14000,
"cumulative_payment_count": 4,
"supporter_count": 4
},
"data": [
{
"id": 1,
"url": "https://example.com/project/example/1",
"title": "プロジェクト1",
"description": "テスト",
"project_type": "crowdfunding",
"publish_status": "limited",
"fundraising_status": "finished",
"start_date": "2025-06-01 15:16:00",
"end_date": "2025-06-30 03:16:59",
"img_url": "https://example.com/api/files/tmp/projects-LQRH20qtitbFsNrJzJC3dttQqQJfZv01OKfmsWUl.png",
"goal_amount": 100000,
"next_goal_amount": 1500000,
"completion_rate": 14.000000000000002,
"cumulative_amount": 14000,
"cumulative_count": 4,
"supporter_count": 4,
"created_at": "2024-06-26 23:49:37",
"updated_at": "2025-06-29 16:17:01"
},
{
"id": 2,
"url": "https://example.com/project/example/2",
"title": "プロジェクト2",
"description": "test",
"project_type": "crowdfunding",
"publish_status": "public",
"fundraising_status": "finished",
"start_date": "2025-10-16 16:43:00",
"end_date": "2025-10-31 16:43:00",
"img_url": "https://example.com/api/files/tmp/projects-LQRH20qtitbFsNrJzJC3dttQqQJfZv01OKfmsWUl.png",
"goal_amount": 1000000,
"next_goal_amount": 1000000000,
"completion_rate": 0,
"cumulative_amount": 0,
"cumulative_count": 0,
"supporter_count": 0,
"created_at": "2025-10-16 17:42:41",
"updated_at": "2025-10-16 17:43:32"
}
]
}

Response Explanation

  • summary - 予約情報
    • project_count - プロジェクト数(合計)
    • cumulative_payment_amount - 金額(合計)
    • cumulative_payment_count - 件数(合計)
    • supporter_count - サポーター数(合計)
  • data - プロジェクト情報
    • id - プロジェクトID
    • url - プロジェクトURL
    • title - プロジェクトタイトル
    • description - プロジェクト説明文
    • project_type - プロジェクトタイプ。(寄付:basic、クラウドファンディング:crowdfunding、マンスリーファンディング:monthly_funding、キフレター:kifu_reter、イベント:event、その他:other、募金:bokin、キャンペーン:campaign、寄贈品指定:item_funding)
    • publish_status - 公開ステータス。(公開:public、限定公開:limited)
    • fundraising_status - 募集ステータス。(募集前:not_started、募集中:ongoing、募集終了:finished)
    • start_date - 募集開始日時
    • end_date - 募集終了日時
    • img_url - プロジェクト画像URL
    • goal_amount - 目標金額
    • next_goal_amount - ネクストゴール金額(設定されていない場合はnull)
    • completion_rate - 達成率(%)
    • cumulative_amount - 決済金額
    • cumulative_count - 決済件数
    • supporter_count - サポーター数
    • created_at - 作成日時
    • updated_at - 更新日時