Search for users based on specified criteria.

POST /crm/objects/2026-03/{objectType}/search

Nach Terminen suchen

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-03/{objectType}/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": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "objectWriteTraceId": "<string>",
      "propertiesWithHistory": {},
      "url": "<string>"
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

objectType · string · erforderlich

„objectTypeId“ des Objekttyps

Body

application/json

Beschreibt eine Suchanfrage

after · string · erforderlich

Ein Paginierungscursor-Token zum Abrufen nachfolgender Seiten.

filterGroups · object[] · erforderlich

Bis zu 6 Filtergruppen zum Definieren zusätzlicher Abfragekriterien.

Show child attributes

limit · integer<int32> · erforderlich

Die maximale Anzahl der Ergebnisse, die zurückgegeben werden (bis zu 200 Objekte).

properties · string[] · erforderlich

Eine Liste der Eigenschaftsnamen, die in die Antwort aufgenommen werden sollen.

sorts · string[] · erforderlich

Spezifiziert die Sortierreihenfolge basierend auf Objekteigenschaften.

query · string

Die Zeichenfolge der Suchabfrage (bis zu 3.000 Zeichen).

Antwort

200

application/json

successful operation

Stellt eine Liste einfacher Objekte dar, die von einer API-Anfrage zurückgegeben werden, zusammen mit der Gesamtzahl der verfügbaren Objekte.

results · object[] · erforderlich

Show child attributes

total · integer<int32> · erforderlich

Die Anzahl der verfügbaren Ergebnisse

paging · object

Show child attributes