Skip to main content
GET
プロパティーを取得

Supported products

承認

Authorization
string
header
必須

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

パスパラメータ

appId
integer<int32>
必須
objectType
string
必須
propertyName
string
必須

クエリパラメータ

archived
boolean
デフォルト:false

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

properties
string

レスポンス

successful operation

A HubSpot property

allowedObjectTypes
object[]
必須

このプロパティーで許可されるオブジェクトタイプを表す文字列の配列。

calculated
boolean
必須

プロパティーが計算されるかどうかを示すブール値。

canArchive
boolean
必須

プロパティーをアーカイブできるかどうかを示すブール値。

canRestore
boolean
必須

プロパティーを復元できるかどうかを示すブール値。

createdAt
integer<int64>
必須

プロパティーが作成された日時を表すISO 8601形式の文字列。

createdUserId
integer<int64>
必須

プロパティを作成したユーザーのIDを表す文字列。

currencyPropertyName
string
必須

このプロパティーに関連付けられている通貨プロパティーの名前を表す文字列。

dataSensitivity
enum<string>
必須

データの機密性レベルを示す文字列。

利用可能なオプション:
high,
none,
standard
dateDisplayHint
enum<string>
必須

日付の表示に関するヒントを提供する文字列。

利用可能なオプション:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
必須

プロパティーが削除されたかどうかを示すブール値。

description
string
必須

プロパティーの説明を提供する文字列。

displayMode
enum<string>
必須

プロパティーの表示モードを示す文字列。

利用可能なオプション:
all_unique_versions,
current_value
displayOrder
integer<int32>
必須

プロパティーが表示される順序を指定する整数。

enforceMultivalueUniqueness
boolean
必須

複数値プロパティーの一意性が適用されるかどうかを示すブール値。

externalOptions
boolean
必須

プロパティーに外部オプションがあるかどうかを示すブール値。

externalOptionsReferenceType
string
必須

外部オプションの参照タイプを示す文字列。

favorited
boolean
必須

プロパティーがお気に入りとしてマークされているかどうかを示すブール値。

favoritedOrder
integer<int32>
必須

お気に入りの中でのプロパティーの順序を指定する整数。

fieldType
string
必須

booleancheckbox、calculation_equation、checkbox、date、file、html、number、phonenumber、radio、select、text、textareaなど、プロパティーのフィールドタイプを示す文字列。

formField
boolean
必須

プロパティーがフォームフィールドとして使用されているかどうかを示すブール値。

fromUserId
integer<int64>
必須

プロパティーの発生元であるユーザーIDを表す文字列。

groupName
string
必須

プロパティーが属するグループの名前を表す文字列。

hasUniqueValue
boolean
必須

プロパティーに一意の値があるかどうかを示すブール値。

hidden
boolean
必須

プロパティーが非表示かどうかを示すブール値。

:

false

hubspotDefined
boolean
必須

プロパティーがHubSpotによって定義されているかどうかを示すブール値。

isCustomizedDefault
boolean
必須

プロパティーがカスタマイズされたデフォルトであるかどうかを示すブール値。

isMultiValued
boolean
必須

プロパティが複数の値を持つことができるかどうかを示すブール値。

isPartial
boolean
必須

プロパティーが部分的なものかどうかを示すブール値。

label
string
必須

表示目的で使用される、プロパティーのラベルを表す文字列。

mutableDefinitionNotDeletable
boolean
必須

プロパティー定義が変更可能だが削除はできないことを示すブール値。

name
string
必須

プロパティーの名前を表す文字列。

numberDisplayHint
enum<string>
必須

数値の表示に関するヒントを提供する文字列。オプションは「unformatted」、「formatted」、「currency」、「percentage」、「duration」、「probability」などです。

利用可能なオプション:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
必須

オプションの並べ替えに使用される戦略を示す文字列。

利用可能なオプション:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
必須

プロパティータイプがオプションをサポートしている場合に適用される、プロパティーで利用可能なオプションの配列。

optionsAreMutable
boolean
必須

プロパティーのオプションが変更可能かどうかを示すブール値。

owningAppId
integer<int64>
必須

プロパティーを所有するアプリのIDを表す整数。

portalId
integer<int64>
必須

ポータルの固有IDを表す整数。

readOnlyDefinition
boolean
必須

プロパティーの定義が読み取り専用であるかどうかを示すブール値。

readOnlyValue
boolean
必須

プロパティーの値が読み取り専用であるかどうかを示すブール値。

referencedObjectType
enum<string>
必須

プロパティーによって参照されるオブジェクトのタイプを示す文字列。

利用可能なオプション:
ABANDONED_CART,
ACCEPTANCE_TEST,
AD,
AD_ACCOUNT,
AD_CAMPAIGN,
AD_GROUP,
AI_FORECAST,
ALL_PAGES,
APPROVAL,
APPROVAL_STEP,
ATTRIBUTION,
AUDIENCE,
AUTOMATION_JOURNEY,
AUTOMATION_PLATFORM_FLOW,
AUTOMATION_PLATFORM_FLOW_ACTION,
BET_ALERT,
BET_DELIVERABLE_SERVICE,
BLOG_LISTING_PAGE,
BLOG_POST,
CALL,
CAMPAIGN,
CAMPAIGN_BUDGET_ITEM,
CAMPAIGN_SPEND_ITEM,
CAMPAIGN_STEP,
CAMPAIGN_TEMPLATE,
CAMPAIGN_TEMPLATE_STEP,
CART,
CASE_STUDY,
CHATFLOW,
CLIP,
CMS_URL,
COMBO_EVENT_CONFIGURATION,
COMMERCE_PAYMENT,
COMMUNICATION,
COMPANY,
CONTACT,
CONTACT_CREATE_ATTRIBUTION,
CONTENT,
CONTENT_AUDIT,
CONTENT_AUDIT_PAGE,
CONVERSATION,
CONVERSATION_INBOX,
CONVERSATION_SESSION,
CRM_OBJECTS_DUMMY_TYPE,
CRM_PIPELINES_DUMMY_TYPE,
CTA,
CTA_VARIANT,
DATA_PRIVACY_CONSENT,
DATA_SYNC_STATE,
DEAL,
DEAL_CREATE_ATTRIBUTION,
DEAL_REGISTRATION,
DEAL_SPLIT,
DISCOUNT,
DISCOUNT_CODE,
DISCOUNT_TEMPLATE,
EMAIL,
ENGAGEMENT,
EXPORT,
EXTERNAL_WEB_URL,
FEE,
FEEDBACK_SUBMISSION,
FEEDBACK_SURVEY,
FILE_MANAGER_FILE,
FILE_MANAGER_FOLDER,
FOLDER,
FORECAST,
FORM,
FORM_SUBMISSION_INBOUNDDB,
GOAL_TARGET,
GOAL_TARGET_GROUP,
GOAL_TEMPLATE,
GSC_PROPERTY,
HUB,
IMPORT,
INVOICE,
KEYWORD,
KNOWLEDGE_ARTICLE,
LANDING_PAGE,
LEAD,
LINE_ITEM,
MARKETING_CALENDAR,
MARKETING_CAMPAIGN_UTM,
MARKETING_EMAIL,
MARKETING_EVENT,
MARKETING_EVENT_ATTENDANCE,
MARKETING_SMS,
MEDIA_BRIDGE,
MEETING_EVENT,
MIC,
NOTE,
OBJECT_LIST,
ORDER,
OWNER,
PARTNER_ACCOUNT,
PARTNER_CLIENT,
PARTNER_CLIENT_REVENUE,
PARTNER_SERVICE,
PAYMENT_LINK,
PAYMENT_SCHEDULE,
PAYMENT_SCHEDULE_INSTALLMENT,
PERMISSIONS_TESTING,
PLAYBOOK,
PLAYBOOK_QUESTION,
PLAYBOOK_SUBMISSION,
PLAYBOOK_SUBMISSION_ANSWER,
PLAYLIST,
PLAYLIST_FOLDER,
PODCAST_EPISODE,
PORTAL,
PORTAL_OBJECT_SYNC_MESSAGE,
POSTAL_MAIL,
PRIVACY_SCANNER_COOKIE,
PRODUCT,
PRODUCT_OR_FOLDER,
PROPERTY_INFO,
PROSPECTING_AGENT_CONTACT_ASSIGNMENT,
PUBLISHING_TASK,
QUARANTINED_SUBMISSION,
QUOTA,
QUOTE,
QUOTE_FIELD,
QUOTE_MODULE,
QUOTE_MODULE_FIELD,
QUOTE_TEMPLATE,
RESTORABLE_CRM_OBJECT,
ROSTER,
ROSTER_MEMBER,
SALES_DOCUMENT,
SALES_TASK,
SALES_WORKLOAD,
SALESFORCE_SYNC_ERROR,
SCHEDULING_PAGE,
SCHEMAS_BACKEND_TEST,
SCORE_CONFIGURATION,
SEQUENCE,
SEQUENCE_ENROLLMENT,
SEQUENCE_STEP,
SEQUENCE_STEP_ENROLLMENT,
SERVICE,
SITE_PAGE,
SNIPPET,
SOCIAL_BROADCAST,
SOCIAL_CHANNEL,
SOCIAL_POST,
SOCIAL_PROFILE,
SOX_PROTECTED_DUMMY_TYPE,
SOX_PROTECTED_TEST_TYPE,
SUBMISSION_TAG,
SUBSCRIPTION,
TASK,
TASK_TEMPLATE,
TAX,
TEMPLATE,
TICKET,
UNKNOWN,
UNSUBSCRIBE,
USER,
VIEW,
VIEW_BLOCK,
WEB_INTERACTIVE
searchTextAnalysisMode
enum<string>
必須

検索目的のテキスト分析モードを示す文字列。

利用可能なオプション:
NONE,
NOT_ANALYZED_TEXT

プロパティーがグローバル検索で検索可能かどうかを示すブール値。

sensitiveDataCategories
string[]
必須

このプロパティーに関連付けられているセンシティブデータのカテゴリを表す文字列の配列。

showCurrencySymbol
boolean
必須

プロパティーの通貨記号を表示するかどうかを示すブール値。

textDisplayHint
enum<string>
必須

テキスト表示のヒントを提供する文字列で、「unformatted_single_line」、「multi_line」、「email」、「phone_number」、「domain_name」、「ip_address」、「physical_address」、「postal_code」などのオプションがあります。

利用可能なオプション:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
必須

「bool」、「date」、「datetime」、「enumeration」、「number」、「phone_number」、「string」など、プロパティーのタイプを示す文字列。

利用可能なオプション:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string,
time_range
updatedAt
integer<int64>
必須

プロパティーが最後に更新された日時を表すISO 8601形式の文字列。

最終更新日 2026年4月10日