Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
0-410
/
search
オブジェクトを検索
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/0-410/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "limit": 123,
  "after": "<string>",
  "sorts": [
    "<string>"
  ],
  "properties": [
    "<string>"
  ],
  "filterGroups": [
    {
      "filters": [
        {
          "highValue": "<string>",
          "propertyName": "<string>",
          "values": [
            "<string>"
          ],
          "value": "<string>",
          "operator": "EQ"
        }
      ]
    }
  ]
}'
{
  "total": 123,
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "<string>",
      "link": "<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"
    }
  ]
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.courses.read

Authorizations

Authorization
string
header
required

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

Path Parameters

objectType
string
required

オブジェクトタイプのobjectTypeId

Body

application/json

Describes a search request

limit
integer
required

The maximum results to return, up to 200 objects.

after
string
required

A paging cursor token for retrieving subsequent pages.

sorts
string[]
required

Specifies sorting order based on object properties.

properties
string[]
required

A list of property names to include in the response.

filterGroups
object[]
required

Up to 6 groups of filters defining additional query criteria.

query
string

The search query string, up to 3000 characters.

Response

successful operation

total
integer
required

The number of available results

results
object[]
required
paging
object