メインコンテンツへスキップ
GET
/
crm-object-schemas
/
2026-03
/
schemas
/
{objectType}
指定されたカスタムオブジェクトのスキーマを取得します。
curl --request GET \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "associations": [
    {
      "fromObjectTypeId": "<string>",
      "id": "<string>",
      "toObjectTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "properties": [
    {
      "description": "<string>",
      "fieldType": "<string>",
      "groupName": "<string>",
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "hidden": true,
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "displayOrder": 123
        }
      ],
      "type": "<string>",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "calculated": true,
      "calculationFormula": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": "<string>",
      "currencyPropertyName": "<string>",
      "displayOrder": 123,
      "externalOptions": true,
      "formField": true,
      "hasUniqueValue": true,
      "hidden": false,
      "hubspotDefined": true,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "readOnlyOptions": true
      },
      "referencedObjectType": "<string>",
      "sensitiveDataCategories": [
        "<string>"
      ],
      "showCurrencySymbol": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedUserId": "<string>"
    }
  ],
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": 123,
  "description": "<string>",
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

objectType
string
必須

スキーマの完全修飾名またはオブジェクトタイプID。

クエリパラメータ

includeAssociationDefinitions
boolean
デフォルト:true
includeAuditMetadata
boolean
デフォルト:true
includePropertyDefinitions
boolean
デフォルト:true

レスポンス

successful operation

allowsSensitiveProperties
boolean
必須
archived
boolean
必須
associations
object[]
必須

特定のオブジェクトタイプについて定義された関連付け。

fullyQualifiedName
string
必須

ポータルIDやオブジェクト名を含む、オブジェクトの割り当てられた固有ID。

id
string
必須

このスキーマのオブジェクトタイプの固有ID。{meta-type}-{unique ID}として定義されます。

labels
object
必須
name
string
必須

スキーマのオブジェクトタイプの重複しない名前。

objectTypeId
string
必須
properties
object[]
必須

このオブジェクトタイプについて定義されたプロパティー。

requiredProperties
string[]
必須

このタイプのオブジェクトを作成する際に「必須」となるプロパティーの名前。

searchableProperties
string[]
必須

HubSpotの製品検索でこのオブジェクトタイプについてインデックスされるプロパティーの名前。

secondaryDisplayProperties
string[]
必須

このオブジェクトのセカンダリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにセカンダリーとして表示されます。

createdAt
string<date-time>

オブジェクトスキーマが作成された日時。

createdByUserId
integer<int32>
description
string
primaryDisplayProperty
string

このオブジェクトのプライマリープロパティーの名前。このオブジェクトタイプのHubSpotレコードページにプライマリーとして表示されます。

updatedAt
string<date-time>

オブジェクトスキーマが最後に更新された日時。

updatedByUserId
integer<int32>
Last modified on April 13, 2026