POST
/
crm
/
v3
/
objects
/
{objectType}
/
search
cURL
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/{objectType}/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,
  "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"
    }
  ],
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

​
必須スコープ

この API には、次のいずれかのスコープが必要です。
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.users.write
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.carts.write
  • crm.objects.appointments.write
  • crm.objects.partner-services.read
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • oauth
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.objects.appointments.sensitive.write.v2
  • media_bridge.read
  • crm.objects.listings.read
  • crm.objects.courses.write
  • crm.objects.carts.read
  • crm.objects.listings.write
  • crm.objects.custom.read
  • crm.objects.deals.read
  • crm.objects.subscriptions.read
  • crm.objects.companies.sensitive.read.v2
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.objects.partner-services.write
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.orders.write
  • crm.objects.subscriptions.write
  • crm.objects.commercepayments.read
  • crm.objects.products.write
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • tickets.highly_sensitive.v2
  • crm.objects.quotes.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.custom.highly_sensitive.write.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.goals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.objects.goals.read
  • crm.objects.partner-clients.write
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.products.read
  • crm.objects.courses.read
  • crm.objects.quotes.read
  • crm.objects.partner-clients.read
  • crm.objects.services.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

Body

application/json

Describes a search request

​
query
string

The search query string, up to 3000 characters.

​
limit
integer

The maximum results to return, up to 200 objects.

​
after
string

A paging cursor token for retrieving subsequent pages.

​
sorts
string[]

Specifies sorting order based on object properties.

​
properties
string[]

A list of property names to include in the response.

​
filterGroups
object[]

Up to 6 groups of filters defining additional query criteria.

Response

successful operation

​
total
integer
required

The number of available results

​
results
object[]
required
​
paging
object