Search for messages

Recherche

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

import requests

url = "https://api.hubapi.com/crm/objects/2026-09/communications/search"

payload = {
    "after": "<string>",
    "filterGroups": [{ "filters": [
                {
                    "propertyName": "<string>",
                    "highValue": "<string>",
                    "value": "<string>",
                    "values": ["<string>"]
                }
            ] }],
    "limit": 123,
    "properties": ["<string>"],
    "sorts": ["<string>"],
    "query": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    after: '<string>',
    filterGroups: [
      {
        filters: [
          {
            propertyName: '<string>',
            highValue: '<string>',
            value: '<string>',
            values: ['<string>']
          }
        ]
      }
    ],
    limit: 123,
    properties: ['<string>'],
    sorts: ['<string>'],
    query: '<string>'
  })
};

fetch('https://api.hubapi.com/crm/objects/2026-09/communications/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/objects/2026-09/communications/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'after' => '<string>',
    'filterGroups' => [
        [
                'filters' => [
                                [
                                                                'propertyName' => '<string>',
                                                                'highValue' => '<string>',
                                                                'value' => '<string>',
                                                                'values' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'limit' => 123,
    'properties' => [
        '<string>'
    ],
    'sorts' => [
        '<string>'
    ],
    'query' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/objects/2026-09/communications/search"

	payload := strings.NewReader("{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/objects/2026-09/communications/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/objects/2026-09/communications/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

POST

crm

objects

2026-09

communications

Recherche

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

import requests

url = "https://api.hubapi.com/crm/objects/2026-09/communications/search"

payload = {
    "after": "<string>",
    "filterGroups": [{ "filters": [
                {
                    "propertyName": "<string>",
                    "highValue": "<string>",
                    "value": "<string>",
                    "values": ["<string>"]
                }
            ] }],
    "limit": 123,
    "properties": ["<string>"],
    "sorts": ["<string>"],
    "query": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    after: '<string>',
    filterGroups: [
      {
        filters: [
          {
            propertyName: '<string>',
            highValue: '<string>',
            value: '<string>',
            values: ['<string>']
          }
        ]
      }
    ],
    limit: 123,
    properties: ['<string>'],
    sorts: ['<string>'],
    query: '<string>'
  })
};

fetch('https://api.hubapi.com/crm/objects/2026-09/communications/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/objects/2026-09/communications/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'after' => '<string>',
    'filterGroups' => [
        [
                'filters' => [
                                [
                                                                'propertyName' => '<string>',
                                                                'highValue' => '<string>',
                                                                'value' => '<string>',
                                                                'values' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'limit' => 123,
    'properties' => [
        '<string>'
    ],
    'sorts' => [
        '<string>'
    ],
    'query' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/objects/2026-09/communications/search"

	payload := strings.NewReader("{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/objects/2026-09/communications/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/objects/2026-09/communications/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"after\": \"<string>\",\n  \"filterGroups\": [\n    {\n      \"filters\": [\n        {\n          \"propertyName\": \"<string>\",\n          \"highValue\": \"<string>\",\n          \"value\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ]\n    }\n  ],\n  \"limit\": 123,\n  \"properties\": [\n    \"<string>\"\n  ],\n  \"sorts\": [\n    \"<string>\"\n  ],\n  \"query\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
      "warnings": [
        {
          "category": "<string>",
          "context": {},
          "message": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Autorisations

Authorization

string

header

requis

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

Corps

application/json

Décrit une demande de recherche

after

string

requis

Une chaîne représentant le jeton de curseur de pagination pour récupérer l'ensemble de résultats suivant après la page actuelle.

filterGroups

object[]

requis

Un tableau de groupes de filtres utilisés pour spécifier les critères de recherche. Chaque groupe de filtres contient plusieurs filtres qui sont combinés à l'aide de l'opérateur logique ET.

Show child attributes

limit

integer<int32>

requis

Un entier spécifiant le nombre maximal de résultats à renvoyer. Cette valeur contrôle la taille de l'ensemble de résultats.

properties

string[]

requis

Un tableau de chaînes indiquant les propriétés des objets CRM à inclure dans les résultats de recherche.

sorts

string[]

requis

Un tableau de chaînes spécifiant l'ordre de tri des résultats de recherche. Chaque chaîne représente une propriété à trier, éventuellement précédée d'un « - » pour un ordre décroissant.

query

string

Une chaîne représentant une requête de recherche pour filtrer les résultats en fonction de termes spécifiques.

Réponse

successful operation

Représente une liste d'objets simples renvoyés par une requête API, ainsi que le nombre total d'objets disponibles.

results

object[]

requis

Un tableau d'éléments SimplePublicObject, chacun représentant un objet individuel dans la collection.

Show child attributes

total

integer<int32>

requis

Le nombre de résultats disponibles

paging

object

Représente les informations de pagination pour naviguer dans une liste de résultats de l'API. Il fournit des détails sur la manière d'accéder à l'ensemble de résultats précédent ou suivant.

Show child attributes

Dernière modification le 6 octobre 2026

Compte et paramètres

Gestion des applications

Authentification

Automatisation

CMS

Préférences de communication

Conversations

CRM

Data Studio

Événements

Fichiers

Marketing

Rendez-vous

Chiffre d'affaires

Webhooks

Journal des webhooks

Autorisations

Corps

Réponse