Retrieve property
Récupérer une propriété spécifique pour un type d’objet donné au sein d’une application spécifiée. Ce point de terminaison vous permet d’accéder aux détails d’une propriété, y compris sa configuration et ses paramètres, pour un type d’objet particulier identifié par le nom de la propriété. Cela peut être utile pour comprendre les configurations de propriété ou à des fins d’intégration.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
Paramètres de chemin
L'identifiant unique de l'application.
Le type d'objet auquel appartient la propriété.
Le nom de la propriété à récupérer.
Paramètres de requête
S'il faut renvoyer uniquement les résultats qui ont été archivés.
Une liste de noms de propriétés séparés par des virgules à inclure dans la réponse.
Réponse
successful operation
A HubSpot property
Un tableau de chaînes de caractères représentant les types d'objets autorisés pour cette propriété.
Un booléen indiquant si la propriété est calculée.
Un booléen indiquant si la propriété peut être archivée.
Un booléen indiquant si la propriété peut être restaurée.
Une chaîne représentant la date et l'heure de création de la propriété, au format ISO 8601.
Chaîne représentant l'ID de l'utilisateur qui a créé la propriété.
Une chaîne représentant le nom de la propriété de devise associée à cette propriété.
Une chaîne indiquant le niveau de sensibilité des données.
high, none, standard Une chaîne fournissant une indication pour l'affichage des dates.
absolute, absolute_with_relative, time_since, time_until Un booléen indiquant si la propriété a été supprimée.
Une chaîne fournissant une description de la propriété.
Une chaîne indiquant le mode d'affichage de la propriété.
all_unique_versions, current_value Un entier spécifiant l'ordre dans lequel la propriété est affichée.
Un booléen indiquant si l'unicité est appliquée pour les propriétés à valeurs multiples.
Une propriété booléenne indiquant si la propriété a des options externes.
Chaîne indiquant le type de référence pour les options externes.
Un booléen indiquant si la propriété est marquée comme favorite.
Un entier spécifiant l'ordre de la propriété parmi les favoris.
Une chaîne indiquant le type de champ de la propriété, tel que « booleancheckbox », « calculation_equation », « checkbox », « date », « file », « html », « number », « phonenumber », « radio », « select », « text » ou « textarea ».
Un booléen indiquant si la propriété est utilisée comme champ de formulaire.
Une chaîne représentant l'ID utilisateur à l'origine de la propriété.
Une chaîne représentant le nom du groupe auquel appartient la propriété.
Un booléen indiquant si la propriété a une valeur unique.
Un booléen indiquant si la propriété est masquée.
false
Un booléen indiquant si la propriété est définie par HubSpot.
Un booléen indiquant si la propriété est une valeur par défaut personnalisée.
Un booléen indiquant si la propriété peut avoir plusieurs valeurs.
Un booléen indiquant si la propriété est partielle.
Une chaîne représentant le libellé de la propriété, utilisée à des fins d'affichage.
Un booléen indiquant si la définition de la propriété est modifiable mais non supprimable.
Une chaîne représentant le nom de la propriété.
Une chaîne fournissant une indication pour l'affichage des nombres, avec des options telles que « non formaté », « formaté », « devise », « pourcentage », « durée » ou « probabilité ».
currency, duration, formatted, percentage, probability, unformatted Une chaîne indiquant la stratégie utilisée pour trier les options.
ALPHABETICAL, DISPLAY_ORDER Un éventail d'options disponibles pour la propriété, applicable si le type de propriété prend en charge les options.
Un booléen indiquant si les options de la propriété sont mutables.
Un entier représentant l'ID de l'application propriétaire de la propriété.
Un entier représentant l'identifiant unique du portail.
Un booléen indiquant si la propriété est en lecture seule.
Un booléen indiquant si la valeur de la propriété est en lecture seule.
Une chaîne indiquant le type d'objet référencé par la propriété.
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 Une chaîne indiquant le mode d'analyse de texte à des fins de recherche.
NONE, NOT_ANALYZED_TEXT Un booléen indiquant si la propriété peut faire l'objet d'une recherche globale.
Un tableau de chaînes de caractères représentant les catégories de données sensibles associées à cette propriété.
Un booléen indiquant si le symbole monétaire doit être affiché pour la propriété.
Une chaîne fournissant une indication pour l'affichage du texte, avec des options telles que « 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 Une chaîne de caractères indiquant le type de la propriété, tel que « bool », « date », « datetime », « enumeration », « number », « phone_number » ou « string ».
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string, time_range Une chaîne représentant la date et l'heure de la dernière mise à jour de la propriété, au format ISO 8601.