Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
0-3
/
batch
/
read
内部ID、または固有のプロパティー値を基準に取引を一括読み取り
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/0-3/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 HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.deals.read

Authorizations

Authorization
string
header
required

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

Path Parameters

objectType
string
required

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

新しいオブジェクトとその履歴のプロパティーを設定するためのキーと値のペア。

inputs
object[]
required
properties
string[]
required

新しいオブジェクトのプロパティーを設定するためのキーと値のペア。

idProperty
string

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

Response

successful operation

A public object batch response object

completedAt
string<date-time>
required

一括処理が完了した時点のタイムスタンプ(ISO 8601形式)。

startedAt
string<date-time>
required

一括処理が開始された時点のタイムスタンプ(ISO 8601形式)。

results
object[]
required
status
enum<string>
required

バッチ処理リクエストのステータス:「PENDING」、「PROCESSING」、「CANCELLED」、または「COMPLETE」

Verfügbare Optionen:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer
requestedAt
string<date-time>

一括要求が最初に行われた時点のタイムスタンプ(ISO 8601形式)。

バッチリクエストに関連する、関連性の高いリンクを含むオブジェクト。

errors
object[]