Search for messages

Buscar

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

Buscar

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

Autorizaciones

Authorization

string

header

requerido

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

FlowAuthorization Code

Authorization URL: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token

Scopes1

crm.objects.deals.read

Cuerpo

application/json

Describe una solicitud de búsqueda

after

string

requerido

Una cadena que representa el token del cursor de paginación para obtener el siguiente conjunto de resultados después de la página actual.

filterGroups

object[]

requerido

Un conjunto de grupos de filtros que se usan para especificar los criterios de búsqueda. Cada grupo de filtros contiene varios filtros que se combinan con un "Y" lógico.

Show child attributes

limit

integer<int32>

requerido

Un número entero que especifica el número máximo de resultados a devolver. Este valor controla el tamaño del conjunto de resultados.

properties

string[]

requerido

Un conjunto de cadenas que indica qué propiedades de los objetos de CRM deben incluirse en los resultados de la búsqueda.

sorts

string[]

requerido

Un conjunto de cadenas que especifica el orden de clasificación de los resultados de búsqueda. Cada cadena representa una propiedad por la cual ordenar, opcionalmente con el prefijo "-" para indicar un orden descendente.

query

string

Una cadena que representa una consulta de búsqueda para filtrar los resultados según términos específicos.

Respuesta

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

Una matriz de elementos SimplePublicObject, cada uno representando un objeto individual en la colección.

Show child attributes

total

integer<int32>

requerido

El número de resultados disponibles

paging

object

Representa la información de paginación para navegar por una lista de resultados en la API. Proporciona detalles sobre cómo acceder al conjunto de resultados anterior o siguiente.

Show child attributes

Última modificación el 23 de septiembre de 2026

Cuenta y configuración

Gestión de aplicaciones

Autenticación

Automatización

CMS

Preferencias de comunicación

Conversaciones

CRM

Data Studio

Eventos

Archivos

Marketing

Reuniones

Ingresos

Webhooks

Registro de webhooks

Autorizaciones

Cuerpo

Respuesta