Die Details für eine Eigenschaft abrufen
Rufen Sie die Details für eine vorhandene Eigenschaft anhand des Namens ab.
Unterstützte Produkte
Unterstützte Produkte
Marketing Hub -Kostenlos
Sales Hub -Kostenlos
Service Hub -Kostenlos
Content Hub -KostenlosAutorisierungen
Pfadparameter
Die appId für die Media-Bridge-App. In Ihrem Entwickler-Account können mehrere Apps vorhanden sein, die die Media Bridge verwenden.
Der Objekttyp für die Eigenschaft.
Der Name der Eigenschaft, für die die Details abgerufen werden sollen.
Abfrageparameter
Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden.
Grenzen Sie die Antwort ein, damit nur die angegebenen Eigenschaften enthalten sind.
Antwort
successful operation
A HubSpot property
Objekttypen, die zur Verwendung dieser Eigenschaft berechtigt sind.
Ob es sich bei der Eigenschaft um ein berechnetes Feld handelt.
Der Zeitstempel, wann die Eigenschaft erstellt wurde (Format ISO 8601).
Die ID des Benutzers, der die Eigenschaft erstellt hat.
Der Name er zugehörigen Währungseigenschaft.
Gibt die Vertraulichkeitsstufe der Eigenschaft an, z. B. „non_sensitive“, „sensitive“ oder „highly_sensitive“.
high, none, standard absolute, absolute_with_relative, time_since, time_until Ob die Eigenschaft gelöscht wurde.
Eine Übersicht über den Zweck der Eigenschaft.
Der Modus, in dem die Eigenschaft angezeigt wird. Kann „current_value“ oder „all_unique_versions“ sein.
all_unique_versions, current_value Die Position des Elements in Bezug auf andere Elemente der Liste.
Gilt nur für Eigenschaften vom Typ „Aufzählung“. Muss in Verbindung mit einem „referencedObjectType“ von „OWNER“ auf „true“ (wahr) festgelegt werden. Ist andernfalls „false“ (falsch).
Wenn „externalOptions“ auf „true“ (wahr) festgelegt ist, werden die Optionswerte der Eigenschaft aus anderen Systemen abgerufen (z. B. „OWNER“ für die Eigenschaft „hubspot_owner_id“).
Veraltet. Ob die Eigenschaft als Favorit markiert ist.
Veraltet. Die Position in der Reihenfolge bei Kennzeichnung als Favorit.
Legt fest, wie die Eigenschaft in der HubSpot-UI oder in einem Formular angezeigt wird. Weitere Informationen in der Anleitung zur Eigenschaften-API.
Ob die Eigenschaft in Formularen verwendet werden kann.
Die ID des Benutzers, der die Eigenschaft zuletzt aktualisiert hat.
Der Name der Gruppe, der die Eigenschaft zugeordnet ist.
Ob es sich bei der Eigenschaft um eine „Eindeutige ID“-Eigenschaft handelt.
Ob die Eigenschaft aus der HubSpot-UI ausgeblendet wird oder nicht. Empfohlen wird, diese Option bei benutzerdefinierten Eigenschaften auf „false“ (falsch) zu setzen.
false
Ein boolescher Wert, der für Standardeigenschaften von HubSpot auf „true“ (wahr) festgelegt ist.
Für Standardeigenschaften; gibt an, ob die Eingeschaft angepasst wurde. Entspricht dem Feld „isCustomizedDefault“.
Ob die Eigenschaften mehrere Werte enthalten kann.
Für Standardeigenschaften; gibt an, ob die Eingeschaft angepasst wurde. Entspricht dem Feld „isCustomizedDefault“.
Das Anzeigelabel für die Eigenschaft.
Ob die Eigenschaftsdefinition angepasst, jedoch nicht gelöscht werden kann.
Der interne Name der Eigenschaft.
Hinweis, wie eine Zahleneigenschaft in der HubSpot-UI angezeigt und validiert wird. Kann „unformatted“, „formatted“, „currency“, „percentage“, „duration“ oder „probability“ sein.
currency, duration, formatted, percentage, probability, unformatted Gibt an, wie Eigenschaftsoptionen sortiert werden. Kann entweder „DISPLAY_ORDER“ zum Verschieben in das Feld „displayOrder“ oder „ALPHABETICAL“ sein.
ALPHABETICAL, DISPLAY_ORDER Eine Liste der gültigen Optionen für die Eigenschaft. Pflichtfeld bei Aufzählungseigenschaften.
Ob Optionen nach der Erstellung geändert werden können.
Die ID des HubSpot-Accounts, in dem die Eigenschaft definiert ist.
Ob die Beschreibung der Eigenschaft schreibgeschützt ist.
Gibt an, ob der Wert der Eigenschaft schreibgeschützt ist.
Veraltet. Verwenden Sie stattdessen „externalOptionsReferenceType“.
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 NONE, NOT_ANALYZED_TEXT Ob die Eigenschaft global durchsuchbar ist.
Führt den in der Eigenschaft enthaltenen Typ vertraulicher Daten (z. B. „HIPAA“) auf, wenn „sensitiveData“ auf „true“ (wahr) festgelegt ist.
Ob das Währungssymbol in der HubSpot-UI anzeigt wird.
Hinweis, wie der Text in der HubSpot-UI angezeigt und validiert wird. Kann „unformatted_single_line“, „multi_line“, „email“, „phone_number“, „domain_name“, „ip_address“, „physical_address“ oder „postal_code“ sein.
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line Der Datentyp der Eigenschaft, z. B. Zeichenfolge oder Zahl.
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string Der Zeitstempel, wann die Eigenschaft zuletzt aktualisiert wurde (Format ISO 8601).