Rendez-vous
Associations v3
Schéma d'associations v3
Associations v4
Schéma d'associations v4
Paniers
Paiements de commerce
Abonnements Commerce
Entreprises
Contacts
Formations
Objets personnalisés
Transactions
Remises
Exports
Frais
Objectifs
Imports
Factures
Leads
Lignes de produits
Listings
Objets
Commandes
Propriétaires
Clients partenaires
Services partenaire
Pipelines
Produits
Projets
Propriétés
Validations de propriétés
Devis
Services
Taxes
Tickets
Communications
Répartitions de transactions
Soumissions d'avis
Suivi des limites
Bibliothèque d'objets
Schémas
curl --request GET \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>'{
"results": [
{
"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"
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Lire toutes les propriétés
Lire toutes les propriétés existantes pour le type d’objet et le compte HubSpot spécifiés.
curl --request GET \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>'{
"results": [
{
"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"
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Produits pris en charge
Produits pris en charge
Marketing Hub -Gratuit
Sales Hub -Gratuit
Service Hub -Gratuit
Content Hub -GratuitPortées requises
Portées requises
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
S'il faut renvoyer uniquement les résultats qui ont été archivés.
highly_sensitive, non_sensitive, sensitive Response
successful operation
Afficher attributs enfants
Afficher attributs enfants
Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.
Contrôle la façon dont la propriété apparaît dans HubSpot.
Le nom du groupe de propriétés auquel appartient la propriété.
Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.
Le nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée par le biais de l'API.
Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées, mais sera vide pour les autres types de propriétés.
Afficher attributs enfants
Afficher attributs enfants
Si vrai, l'option ne sera pas affichée dans des formulaires, des bots ou des pages de planification de réunions. Pris en charge pour les propriétés d'énumération de contacts, d'entreprises, de tickets et d'objets personnalisés.
Un libellé d'option qui sera affiché dans HubSpot lisible par les personnes.
La valeur interne de l'option, qui doit être utilisé lorsque la valeur de propriété est définie par le biais de l'API.
Une description de l'option.
Les options sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse. Les valeurs de -1 feront apparaître l'option après chaque valeur positive.
Le type de données de la propriété.
Si la propriété est archivée ou non.
Moment où la propriété a été archivée
Pour les propriétés par défaut, vrai indique que la propriété est calculée par un processus HubSpot. Cela n'a aucun effet pour les propriétés personnalisées.
Cela représente une formule utilisée pour calculer une propriété calculée.
Date à laquelle la propriété a été créée, au format ISO 8601.
L'ID utilisateur interne de l'utilisateur qui a créé la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été créée en dehors de HubSpot.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive absolute, absolute_with_relative, time_since, time_until Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse.
Par défaut, vrai indique que les options sont stockées en dehors des paramètres de propriété.
Si la propriété peut être utilisée dans un formulaire HubSpot ou non.
Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.
Si vrai, l'option ne sera pas affichée dans des formulaires, des bots ou des pages de planification de réunions. Pris en charge pour les propriétés d'énumération de contacts, d'entreprises, de tickets et d'objets personnalisés.
Cette valeur sera « vrai » pour les propriétés d'objet par défaut intégrées dans HubSpot.
Si cette propriété est liée à un ou plusieurs autres objets, ils seront répertoriés ici.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Si la propriété affiche ou non le symbole de la devise défini dans les paramètres du compte.
L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.
L'ID utilisateur interne de l'utilisateur qui a mis à jour la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été mise à jour en dehors de HubSpot.
Afficher attributs enfants
Afficher attributs enfants
specifies the paging information needed to retrieve the previous set of results in a paginated API response