必須スコープ
この API には、次のいずれかのスコープが必要です。crm.objects.orders.read
crm.objects.appointments.sensitive.read.v2
crm.schemas.listings.read
crm.objects.contacts.highly_sensitive.read.v2
crm.schemas.carts.read
automation
crm.objects.companies.write
crm.objects.custom.sensitive.read.v2
crm.objects.users.read
crm.objects.commercepayments.write
crm.objects.invoices.write
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.appointments.write
crm.objects.custom.write
tickets
crm.objects.deals.sensitive.write.v2
crm.schemas.appointments.read
crm.objects.deals.highly_sensitive.write.v2
crm.objects.companies.highly_sensitive.write.v2
tickets.sensitive.v2
crm.objects.appointments.read
crm.schemas.courses.read
crm.objects.appointments.sensitive.write.v2
crm.schemas.custom.read
crm.objects.marketing_events.write
media_bridge.read
crm.schemas.commercepayments.read
crm.objects.listings.read
crm.objects.courses.write
crm.objects.carts.read
crm.objects.listings.write
crm.objects.custom.read
crm.objects.deals.read
crm.objects.subscriptions.read
crm.objects.owners.read
crm.objects.companies.sensitive.read.v2
crm.schemas.quotes.read
crm.objects.companies.read
crm.objects.custom.sensitive.write.v2
crm.schemas.services.read
crm.objects.deals.highly_sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.companies.highly_sensitive.read.v2
crm.schemas.subscriptions.read
crm.schemas.companies.read
crm.schemas.line_items.read
crm.objects.contacts.read
crm.objects.services.write
crm.objects.subscriptions.write
crm.objects.products.write
crm.objects.feedback_submissions.read
crm.objects.custom.highly_sensitive.read.v2
crm.objects.deals.write
crm.objects.invoices.read
e-commerce
crm.schemas.deals.read
crm.schemas.orders.read
crm.schemas.contacts.read
tickets.highly_sensitive.v2
crm.objects.quotes.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.custom.highly_sensitive.write.v2
crm.objects.deals.sensitive.read.v2
crm.objects.goals.write
crm.objects.companies.sensitive.write.v2
crm.objects.contacts.write
crm.objects.goals.read
crm.objects.line_items.read
crm.objects.contacts.sensitive.read.v2
crm.objects.line_items.write
crm.objects.courses.read
timeline
crm.pipelines.orders.read
crm.schemas.invoices.read
crm.objects.quotes.read
crm.objects.services.read
crm.objects.marketing_events.read
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
successful operation
A HubSpot property
HubSpotにヘルプテキストとして表示されるプロパティーの説明。
プロパティーのデータ型。
"enumeration"
プロパティーに有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要ですが、他のプロパティータイプでは空になります。
"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"
HubSpotに表示される、人間が読めるプロパティーラベル。
"My Contact Property"
プロパティーが含まれているプロパティーグループの名前。
"contactinformation"
このAPIを使用してプロパティーを参照する際に使用する必要がある内部プロパティー名。
"my_contact_property"
HubSpotでのプロパティーの表示が制御されます。
"select"
HubSpot UIでプロパティーが非表示になるかどうか。カスタムプロパティーの場合、これをfalseに設定することをお勧めします。
プロパティーは、正の整数値の低い順に表示されます。
2
プロパティーによってアカウント設定で定義された通貨記号が表示されるかどうか。
HubSpotに組み込まれている既定のオブジェクトプロパティーではtrueになります。
プロパティーが作成された時刻のタイムスタンプ(ISO 8601形式)。
プロパティーがアーカイブされているかどうか。
プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。
既定のプロパティーの場合、trueはプロパティーがHubSpotプロセスによって計算されることを示します。カスタムプロパティーの場合は効果がありません。
既定のプロパティーの場合、trueはオプションがプロパティー設定外に格納されていることを示します。
absolute
, absolute_with_relative
, time_since
, time_until
プロパティーが最後に更新されたタイムスタンプ(ISO 8601形式)。
HubSpotでプロパティーを作成したユーザーの内部ユーザーID。プロパティーがHubSpot外で作成された場合、このフィールドは存在しない場合があります。
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
HubSpotフォームにプロパティーを使用できるかどうか。
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
non_sensitive
, sensitive
, highly_sensitive
プロパティーがアーカイブされた日時
このプロパティーが他のオブジェクトに関連している場合、ここに一覧で表示されます。
計算プロパティーの計算に使用される式を表します。
HubSpotでプロパティーを更新したユーザーの内部ユーザーID。プロパティーがHubSpot外で更新された場合、このフィールドは存在しない場合があります。