GET
/
marketing
/
v3
/
campaigns
/
キャンペーン検索
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/campaigns/ \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubProfessional
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

​
必須スコープ

この API には、次のいずれかのスコープが必要です。
  • marketing.campaigns.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
sort
string

結果を並べ替える基準となるフィールド。許容される値はhs_name、createdAt、updatedAtです。プロパティー名の前に任意で「-」を付けて降順であることを示すことができます 既定値：hs_name

​
after
string

ページ送り用のカーソル。指定すると、結果は指定したカーソルの後から開始されます。 例：NTI1Cg%3D%3D

​
limit
integer

返す結果の最大数。許容される値の範囲は1～100 デフォルト：50

​
name
string

名前に指定した部分文字列が含まれるキャンペーンを返すフィルター。これにより、キャンペーン名の部分一致が可能になり、名前に指定した部分文字列が含まれる全てのキャンペーンが返されるようになります。このパラメーターを指定しない場合、検索では全てのキャンペーンが返されます

​
properties
string[]

レスポンスで返されるプロパティーのカンマ区切りリスト。指定されたプロパティーのいずれかに要求されたオブジェクトの空の値が含まれる場合は無視され、レスポンスで返されません。このパラメーターが空の場合、レスポンスには空のプロパティーマップが含まれます

Response

200
application/json

successful operation

The response is of type object.