Zum Hauptinhalt springen
GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
プロパティーを読み取る
curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
automation
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.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.feedback_submissions.read
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.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.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.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Query Parameters

​
archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

​
properties
string

Response

successful operation

A HubSpot property

​
description
string
required

HubSpotにヘルプテキストとして表示されるプロパティーの説明。

​
type
string
required

プロパティーのデータ型。

​
options
object[]
required

プロパティーに有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要ですが、他のプロパティータイプでは空になります。

​
label
string
required

HubSpotに表示される、人間が読めるプロパティーラベル。

​
groupName
string
required

プロパティーが含まれているプロパティーグループの名前。

​
name
string
required

このAPIを使用してプロパティーを参照する際に使用する必要がある内部プロパティー名。

​
fieldType
string
required

HubSpotでのプロパティーの表示が制御されます。

​
hidden
boolean

trueの場合、このオプションはフォーム、ボット、またはミーティング設定ページに表示されません。コンタクト、会社、チケット、およびカスタムオブジェクトの列挙プロパティーではサポートされています。

​
displayOrder
integer

プロパティーは、正の整数値の低い順に表示されます。

​
showCurrencySymbol
boolean

プロパティーによってアカウント設定で定義された通貨記号が表示されるかどうか。

​
hubspotDefined
boolean

HubSpotに組み込まれている既定のオブジェクトプロパティーではtrueになります。

​
createdAt
string<date-time>

プロパティーが作成された時刻のタイムスタンプ（ISO 8601形式）。

​
archived
boolean

プロパティーがアーカイブされているかどうか。

​
hasUniqueValue
boolean

プロパティーの値が固有である必要があるかどうか。設定すると、変更はできません。

​
calculated
boolean

既定のプロパティーの場合、trueはプロパティーがHubSpotプロセスによって計算されることを示します。カスタムプロパティーの場合は効果がありません。

​
externalOptions
boolean

既定のプロパティーの場合、trueはオプションがプロパティー設定外に格納されていることを示します。

​
dateDisplayHint
enum<string>
Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
​
updatedAt
string<date-time>

プロパティーが最後に更新されたタイムスタンプ（ISO 8601形式）。

​
createdUserId
string

HubSpotでプロパティーを作成したユーザーの内部ユーザーID。プロパティーがHubSpot外で作成された場合、このフィールドは存在しない場合があります。

​
modificationMetadata
object
​
sensitiveDataCategories
string[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

​
formField
boolean

HubSpotフォームにプロパティーを使用できるかどうか。

​
dataSensitivity
enum<string>

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Verfügbare Optionen:
non_sensitive,
sensitive,
highly_sensitive
​
archivedAt
string<date-time>

プロパティーがアーカイブされた日時

​
referencedObjectType
string

このプロパティーが他のオブジェクトに関連している場合、ここに一覧で表示されます。

​
calculationFormula
string

計算プロパティーの計算に使用される式を表します。

​
updatedUserId
string

HubSpotでプロパティーを更新したユーザーの内部ユーザーID。プロパティーがHubSpot外で更新された場合、このフィールドは存在しない場合があります。