Zum Hauptinhalt springen
POST
/
crm
/
objects
/
2025-09
/
{objectType}
/
batch
/
read
内部ID、または固有のプロパティー値を基準にオブジェクトを一括で読み取り
curl --request POST \
  --url https://api.hubapi.com/crm/objects/2025-09/{objectType}/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.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.carts.write
crm.objects.commercepayments.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.orders.read
crm.objects.orders.write
crm.objects.partner-clients.read
crm.objects.partner-clients.write
crm.objects.partner-services.read
crm.objects.partner-services.write
crm.objects.products.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.objects.users.write
e-commerce
media_bridge.read
oauth
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

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」

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

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

​
links
object

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

​
errors
object[]