Read a batch of tasks by internal ID, or unique property values

Recupere registros por ID de registro ou inclua o parâmetro “idProperty” para recuperar registros por uma propriedade de valor exclusivo personalizada.

POST /crm/v3/objects/tasks/batch/read

Ler um lote de tarefas por ID interno ou por valores de propriedade exclusivos

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/tasks/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    {
      "id": "430001"
    }
  ],
  "properties": [
    "<string>"
  ],
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>"
}
'

200

{
  "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",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

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.

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

Show child attributes

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

200

application/json

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

Show child attributes

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: "PENDENTE", "PROCESSANDO", "CANCELADO" ou "CONCLUÍDO"

Opções disponíveis: CANCELED, COMPLETE, PENDING, PROCESSING

links · object

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

Show child attributes

requestedAt · string<date-time>

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