HUhubspot
Search

Search for taxes using specified criteria.

Changed on

Execute a search for tax objects based on defined filters, sorting options, and properties to be included in the response. This allows for customized retrieval of tax data according to specific search parameters.

post/crm/v3/objects/taxes/search

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/v3/objects/taxes/search
  • Auth
    none required

Request body

afterstring required

A paging cursor token for retrieving subsequent pages.

limitinteger required

The maximum results to return, up to 200 objects.

propertiesstring[] required

A list of property names to include in the response.

querystring

The search query string, up to 3000 characters.

sortsstring[] required

Specifies sorting order based on object properties.

Response

successful operation

totalinteger required

The number of available results

Example response

{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  },
  "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"
    }
  ]
}

Changes