CRM
日本語
cURL
curl --request POST \ --url https://api.hubapi.com/crm/v3/objects/0-3/search \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "after": "<string>", "filterGroups": [ { "filters": [ { "operator": "BETWEEN", "propertyName": "<string>", "highValue": "<string>", "value": "<string>", "values": [ "<string>" ] } ] } ], "limit": 123, "properties": [ "<string>" ], "sorts": [ "<string>" ], "query": "<string>" } '
{ "results": [ { "archived": false, "createdAt": "2019-10-30T03:30:17.883Z", "id": "512", "properties": { "property_checkbox": "false", "property_date": "1572480000000", "property_dropdown": "choice_b", "property_multiple_checkboxes": "chocolate;strawberry", "property_number": "17", "property_radio": "option_1", "property_string": "value" }, "updatedAt": "2019-12-07T16:50:06.678Z" } ], "total": 123, "paging": { "next": { "after": "NTI1Cg%3D%3D", "link": "?after=NTI1Cg%3D%3D" }, "prev": { "before": "<string>", "link": "<string>" } } }
指定した条件とフィルターを使用して、取引を検索します。
サポートされる製品
必須スコープ
The access token received from the authorization server in the OAuth 2.0 flow.
Describes a search request
後続のページを取得するためのページングカーソルトークン。
追加のクエリー条件を定義する最大6件のフィルターグループ。
表示 子属性
null
BETWEEN
CONTAINS_TOKEN
EQ
GT
GTE
HAS_PROPERTY
IN
LT
LTE
NEQ
NOT_CONTAINS_TOKEN
NOT_HAS_PROPERTY
NOT_IN
フィルターを適用するプロパティーの名前。
範囲ベースのフィルターを使用した場合の上限境界値。
プロパティーと照合する値。
返される結果の最大値(最大200件のオブジェクト)。
レスポンスに含めるプロパティー名のリスト。
オブジェクトのプロパティーに基づいて表示順を指定します。
検索クエリー文字列。最大3000文字。
successful operation
オブジェクトがアーカイブされているかどうか。
オブジェクトが作成された時点のタイムスタンプ(ISO 8601形式)。
オブジェクトの固有ID。
オブジェクトのプロパティーを表す、キーと値のペア。
オブジェクトが最後に更新された時点のタイムスタンプ(ISO 8601形式)。
オブジェクトがアーカイブされた時点のタイムスタンプ(ISO 8601形式)。
オブジェクトのプロパティーとその履歴を表すキーと値のペア。
プロパティーのタイプ。
プロパティーが更新された時刻のタイムスタンプ(ISO 8601形式)。
プロパティー値。
プロパティーの固有ID。
人間が読めるラベル。
プロパティーを最後に更新したユーザーのID。
The number of available results
Specifies the paging information needed to retrieve the next set of results in a paginated API response
次ページの結果を取得するために使用できるURL。
{ "after": "NTI1Cg%3D%3D", "link": "?after=NTI1Cg%3D%3D"}
specifies the paging information needed to retrieve the previous set of results in a paginated API response
前のページを取得するためのページ操作カーソルトークン。
前のページの結果を取得するために使用できるURL。