younifyd
Menu

Post /crm/v3/objects/{object Type}/search Do Search

Search for CRM objects of a specified type.

POST/crm/v3/objects/{objectType}/search

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Post /crm/v3/objects/{object Type}/search Do Search action (under Custom Objects).
  3. Fill in the fields below, then reference the result from later steps as {{postCrmV3ObjectsObjectTypeSearchDoSearch.response.data}}.

Request

Path parameters

objectTypestringrequired

Request body

Enter the body as JSON in the step's Body field.

afterstringrequired

A paging cursor token for retrieving subsequent pages.

filterGroupsarray<object>required

Up to 6 groups of filters defining additional query criteria.

filtersarray<object>required5 fields
limitinteger (int32)required

The maximum results to return, up to 200 objects.

propertiesarray<string>required

A list of property names to include in the response.

querystring

The search query string, up to 3000 characters.

sortsarray<string>required

Specifies sorting order based on object properties.

json
{
  "after": "string",
  "filterGroups": [
    {
      "filters": [
        {
          "operator": "BETWEEN",
          "propertyName": "string",
          "highValue": "string",
          "value": "string",
          "values": [
            "string"
          ]
        }
      ]
    }
  ],
  "limit": 0,
  "properties": [
    "string"
  ],
  "sorts": [
    "string"
  ],
  "query": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{postCrmV3ObjectsObjectTypeSearchDoSearch.response.data.<field>}}.

pagingobject
nextobject2 fields

Specifies the paging information needed to retrieve the next set of results in a paginated API response

prevobject2 fields

specifies the paging information needed to retrieve the previous set of results in a paginated API response

resultsarray<object>
archivedbooleanrequired

Whether the object is archived.

archivedAtstring (date-time)

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring (date-time)required

The timestamp when the object was created, in ISO 8601 format.

idstringrequired

The unique ID of the object.

objectWriteTraceIdstring

An identifier used for tracing the write request for the object.

propertiesobjectrequired

Key-value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring (date-time)required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.

warningsarray<object>3 fields
totalinteger (int32)

The number of available results

json
{
  "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": 0,
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "string",
      "link": "string"
    }
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.