メインコンテンツへスキップ
POST
/
crm
/
v3
/
properties
/
{objectType}
/
batch
/
read
プロパティーをバッチで読み取る
curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "dataSensitivity": "highly_sensitive",
  "inputs": [
    {
      "name": "my_custom_property"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "displayOrder": 2,
      "fieldType": "select",
      "formField": true,
      "groupName": "contactinformation",
      "hasUniqueValue": false,
      "hidden": false,
      "label": "My Contact Property",
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": false,
        "readOnlyOptions": false,
        "readOnlyValue": false
      },
      "name": "my_contact_property",
      "options": [
        {
          "description": "Choice number one",
          "displayOrder": 1,
          "hidden": false,
          "label": "Option A",
          "value": "A"
        },
        {
          "description": "Choice number two",
          "displayOrder": 2,
          "hidden": false,
          "label": "Option B",
          "value": "B"
        }
      ],
      "type": "enumeration"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

objectType
string
必須

プロパティーを読み取るオブジェクトのタイプ。

クエリパラメータ

locale
string

プロパティー値の言語ロケールを指定します。

ボディ

application/json
archived
boolean
必須

プロパティーがアーカイブ済みかどうかを指定します。

dataSensitivity
enum<string>
必須

「non_sensitive」、「sensitive」、「highly_sensitive」など、データのセンシティブ(慎重に扱うべき)レベルを示します。

利用可能なオプション:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
必須

レスポンス

successful operation

completedAt
string<date-time>
必須

バッチ処理が完了した日時を示すタイムスタンプ。

results
object[]
必須
startedAt
string<date-time>
必須

バッチ処理が開始された日時を示すタイムスタンプ。

status
enum<string>
必須

バッチ処理の現在のステータス。許容される値は、CANCELED、COMPLETE、PENDING、PROCESSINGです。

利用可能なオプション:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

バッチ処理に関連するドキュメントまたは資料につながるURLのコレクション。

requestedAt
string<date-time>

バッチ処理が要求された日時を示すタイムスタンプ。

Last modified on April 13, 2026