POST /crm/v3/objects/notes/search

Para ejecutar una búsqueda de notas, utiliza filtros, opciones de ordenamiento y otros parámetros de consulta para refinar los resultados. Este punto de terminación permite que consultas complejas ubiquen notas específicas dentro del sistema del CRM.

POST /crm/v3/objects/notes/search

Buscar notas en función de los criterios especificados.

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/notes/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "after": "<string>",
  "filterGroups": [
    {
      "filters": [
        {
          "operator": "BETWEEN",
          "propertyName": "<string>",
          "highValue": "<string>",
          "value": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "limit": 123,
  "properties": [
    "<string>"
  ],
  "sorts": [
    "<string>"
  ],
  "query": "<string>"
}
'

200

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

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.

Marketing Hub -Gratuito

Sales Hub -Gratuito

Service Hub -Gratuito

Content Hub -Gratuito

Ámbitos Requeridos

Autorizaciones

oauth2private_apps

Authorization · string · header · requerido

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

Cuerpo

application/json

Describe una solicitud de búsqueda

after · string · requerido

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

filterGroups · object[] · requerido

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

Show child attributes

limit · integer<int32> · requerido

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

properties · string[] · requerido

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

sorts · string[] · requerido

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

query · string

La cadena de texto de la consulta, hasta 3000 caracteres

Respuesta

200

application/json

successful operation

Representa una lista de objetos simples devueltos de una solicitud a la API, junto con el total de objetos disponibles.

results · object[] · requerido

Show child attributes

total · integer<int32> · requerido

El número de resultados disponibles

paging · object

Show child attributes