Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
tickets
/
batch
/
read
内部ID、または固有のプロパティー値を基準にチケットを一括読み取り
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/tickets/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "propertiesWithHistory": [
    "<string>"
  ],
  "idProperty": "<string>",
  "inputs": [
    {
      "id": "<string>"
    }
  ],
  "properties": [
    "<string>"
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "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"
    }
  ],
  "errors": [
    {
      "subCategory": {},
      "context": {},
      "links": {},
      "id": "<string>",
      "category": "<string>",
      "message": "<string>",
      "errors": [
        {
          "subCategory": "<string>",
          "code": "<string>",
          "in": "<string>",
          "context": "{\"missingScopes\":[\"scope1\",\"scope2\"]}",
          "message": "<string>"
        }
      ],
      "status": "<string>"
    }
  ],
  "status": "PENDING"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing Hub
Marketing Hub無料ツール
Sales Hub
Sales Hub無料ツール
Service Hub
Service Hub無料ツール
Content Hub
Content Hub無料ツール

Authorizations

Authorization
string
header
required

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

Query Parameters

archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

Body

application/json

Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.

propertiesWithHistory
string[]
required

Key-value pairs for setting properties for the new object and their histories.

inputs
object[]
required
properties
string[]
required

Key-value pairs for setting properties for the new object.

idProperty
string

カスタム固有値プロパティーを使用してレコードを取得する場合は、プロパティーの名前。レコードIDによって取得する場合は、このパラメーターを含めないでください。

Response

successful operation

A public object batch response object

completedAt
string<date-time>
required

The timestamp when the batch processing was completed, in ISO 8601 format.

startedAt
string<date-time>
required

The timestamp when the batch processing began, in ISO 8601 format.

results
object[]
required
status
enum<string>
required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer
requestedAt
string<date-time>

The timestamp when the batch request was initially made, in ISO 8601 format.

An object containing relevant links related to the batch request.

errors
object[]