POST
/
crm
/
v3
/
objects
/
0-3
/
search
cURL
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/0-3/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>"
    }
  }
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • crm.objects.deals.read

Authorizations

Authorization
string
header
required

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

Body

application/json

Describes a search request

query
string

La cadena de texto de la consulta, hasta 3000 caracteres

limit
integer

El número máximo de resultados que se devolverán, hasta 200 objetos.

after
string

Un token del cursor de paginación para recuperar páginas posteriores.

sorts
string[]

Especifica el orden de clasificación en función de las propiedades del objeto.

properties
string[]

Una lista de propiedades que se incluirán en la respuesta.

filterGroups
object[]

Hasta seis grupos de filtros que definen criterios de consulta adicionales.

Response

successful operation

total
integer
required

The number of available results

results
object[]
required
paging
object