Search

Search for quotes using specified criteria.

Execute a search for quotes based on the criteria defined in the request body, such as filters, properties, and sorting options. This endpoint allows for detailed querying of quote records to retrieve specific data sets.

post/crm/v3/objects/quotes/search

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

Changed in 16 of the 59 revisions of this API.634

    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security oauth2 was removed from the API

      api-security-removed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      endpoint added

      endpoint-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v3a0dbba00d7b533See the full diff
    • ▲

      removed the enum value BETWEEN(VALUE of the request property ////

      request-property-enum-value-removed

    • ▲

      removed the enum value HIGH_VALUE) of the request property ////

      request-property-enum-value-removed

    • ▲

      the / request property type changed from object to string

      request-property-type-changed

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • ○

      added the new BETWEEN enum value to the request property ////

      request-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the security scope crm.objects.quotes.read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • ○

      the security scope e-commerce was removed from the endpoint's security scheme oauth2

      api-security-scope-removed