Obtenir les détails d'une propriété
Obtenir les détails d’une propriété existante par son nom.
Marketing HubGratuit
Sales HubGratuit
Service HubGratuit
Content HubGratuitAutorisations
Paramètres de chemin
L'appId de l'application Media Bridge. Il est possible d'avoir plusieurs applications dans votre compte développeur qui utilisent le Media Bridge.
Le type d'objet pour la propriété.
Le nom de la propriété pour laquelle les détails doivent être obtenus.
Paramètres de requête
S'il faut renvoyer uniquement les résultats qui ont été archivés.
Limiter la réponse aux propriétés spécifiées.
Réponse
successful operation
A HubSpot property
Types d'objets autorisés à utiliser cette propriété.
Si la propriété est un champ calculé.
Date à laquelle la propriété a été créée, au format ISO 8601.
L'ID de l'utilisateur qui a créé la propriété.
Le nom de la propriété de la devise associée.
Indique le niveau de sensibilité de la propriété, par exemple « non_sensitive », « sensitive » ou « highly_sensitive ».
high, none, standard absolute, absolute_with_relative, time_since, time_until Indique si la propriété a été supprimée.
Un résumé de l'objectif de la propriété.
Mode d'affichage de la propriété. Peut être : « current_value » ou « all_unique_versions ».
all_unique_versions, current_value La position de l'élément par rapport aux autres éléments de la liste.
Applicable uniquement aux propriétés de type « énumération ». Doit être définie sur « true » avec un « referencedObjectType » de « OWNER ». Sinon, définir sur « false ».
Lorsque externalOptions est défini sur true, cela indique que les valeurs d'option de la propriété seront renseignées à partir d'autres systèmes (par exemple, « OWNER » pour la propriété hubspot_owner_id).
Obsolète. Indique si la propriété est marquée comme favorite.
Obsolète. La position de l'ordre lorsqu'il est marqué comme favori.
Détermine comment la propriété apparaîtra dans l'interface utilisateur de HubSpot ou sur un formulaire. Pour en savoir plus, consultez le guide de l'API sur les propriétés.
Si la propriété peut apparaître sur les formulaires.
L'ID de l'utilisateur qui a mis à jour la propriété pour la dernière fois.
Le nom du groupe auquel la propriété est attribuée.
Indique si la propriété est une propriété à identifiant unique.
Si la propriété sera masquée de l'interface utilisateur HubSpot ou non. Il est recommandé de laisser la valeur définie sur « faux » pour les propriétés personnalisées.
false
Une valeur booléenne fixée à true pour les propriétés par défaut de HubSpot.
Pour les propriétés par défaut, indique si la propriété a été personnalisée. Équivalent du champ « isCustomizedDefault ».
Si la propriété peut contenir plusieurs valeurs.
Pour les propriétés par défaut, indique si la propriété a été personnalisée. Équivalent du champ « isCustomizedDefault ».
Le libellé d'affichage de la propriété.
Si la définition de la propriété peut être personnalisée mais pas supprimée.
Le nom interne de la propriété.
Indication sur la manière dont une propriété numérique est affichée et validée dans l'interface utilisateur de HubSpot. Peut être : « non formaté », « formaté », « devise », « pourcentage », « durée » ou « probabilité ».
currency, duration, formatted, percentage, probability, unformatted Spécifie comment trier les options de propriété. Peut être soit « DISPLAY_ORDER » pour se référer au champ displayOrder, soit « ALPHABETICAL ».
ALPHABETICAL, DISPLAY_ORDER Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées.
Si les options peuvent être modifiées après la création.
L'ID du compte HubSpot où la propriété est définie.
Indique si la description de la propriété est en lecture seule.
Indique si la valeur de la propriété est en lecture seule.
Obsolète. Utilisez plutôt 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 Si la propriété peut faire l'objet d'une recherche à l'échelle mondiale.
Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, « HIPAA »).
Afficher ou non le symbole de la devise dans l'interface utilisateur de HubSpot.
Indication sur la manière dont le texte est affiché et validé dans l'interface utilisateur de HubSpot. Peut être = : « unformatted_single_line », « multi_line », « email », « phone_number », « domain_name », « ip_address », « physical_address » ou « postal_code ».
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line Le type de données de la propriété, par exemple une chaîne ou un nombre.
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.