Pular para o conteúdo principal
POST
/
crm
/
v3
/
objects
/
tickets
/
batch
/
read
Ler um lote de tickets por ID interno ou por valores de propriedade exclusivos
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/tickets/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "<string>"
  ],
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>"
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "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"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

Corpo

application/json

Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.

inputs
object[]
obrigatório
properties
string[]
obrigatório

Pares de chave-valor para definir propriedades para o novo objeto.

propertiesWithHistory
string[]
obrigatório

Pares de chave-valor para definir propriedades para o novo objeto e seus históricos.

idProperty
string

Ao usar uma propriedade de valor exclusivo personalizada para recuperar registros, este é o nome da propriedade. Não inclua esse parâmetro se estiver recuperando por ID de registro.

Resposta

successful operation

Um objeto de resposta em lote de objeto público

completedAt
string<date-time>
obrigatório

A data e hora em que o processamento em lote foi concluído, no formato ISO 8601.

results
object[]
obrigatório
startedAt
string<date-time>
obrigatório

A data e hora em que o processamento em lote foi iniciado, no formato ISO 8601.

status
enum<string>
obrigatório

O status da solicitação de processamento em lote. O valor esperado é "CONCLUÍDO".

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Um objeto contendo links relevantes relacionados à solicitação em lote.

numErrors
integer<int32>

O número total de erros que ocorreram durante a operação em lote.

requestedAt
string<date-time>

A data e hora em que a solicitação em lote foi feita inicialmente, no formato ISO 8601.

Last modified on January 23, 2026