Search for orders in the CRM using various filters and sorting options to retrieve specific order data.

Pesquisar

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-09/orders/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/orders/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/orders/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/orders/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/orders/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/orders/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/orders/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

orders

Pesquisar

curl --request POST \
  --url https://api.hubapi.com/crm/objects/2026-09/orders/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/orders/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/orders/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/orders/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/orders/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/orders/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/orders/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

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

Descreve uma solicitação de pesquisa

after

string

obrigatório

Uma string que representa o token do cursor de paginação do último recurso lido com sucesso. Este token é usado na paginação para recuperar o próximo conjunto de resultados.

filterGroups

object[]

obrigatório

Uma matriz de grupos de filtros usada para especificar os critérios de pesquisa. Cada grupo de filtros contém vários filtros que definem as condições para a pesquisa.

Show child attributes

limit

integer<int32>

obrigatório

Um número inteiro que especifica o número máximo de resultados a serem retornados. Este valor controla o tamanho da página dos resultados da pesquisa.

properties

string[]

obrigatório

Uma matriz de strings que especifica as propriedades a serem retornadas nos resultados da pesquisa. Se uma propriedade especificada não estiver presente no(s) objeto(s) solicitado(s), ela será ignorada.

sorts

string[]

obrigatório

Uma matriz de strings que define a ordem de classificação dos resultados da pesquisa. Cada string especifica uma propriedade para classificar, opcionalmente seguida por uma direção (por exemplo, "propertyName ASC").

query

string

Uma string usada para realizar uma pesquisa de texto completo nas propriedades especificadas.

Resposta

successful operation

Representa uma lista de objetos simples retornados de uma solicitação de API, juntamente com o número total de objetos disponíveis.

results

object[]

obrigatório

Uma matriz contendo os objetos públicos simples retornados na resposta atual.

Show child attributes

total

integer<int32>

obrigatório

O número de resultados disponíveis

paging

object

Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados.

Show child attributes

Última modificação em 6 de outubro de 2026

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Data Studio

Eventos

Arquivos

Marketing

Reuniões

Receita

Webhooks

Diário de Webhooks

Search for orders in the CRM using various filters and sorting options to retrieve specific order data.

Autorizações

Corpo

Resposta