Account & Settings
App-Verwaltung
Authentifizierung
Automatisierung
CMS
Communication preferences
Konversationen
CRM
Veranstaltungen
Dateien
Marketing
Berichterstattung
Scheduler
curl --request GET \
--url https://api.hubapi.com/properties/v1/companies/properties/named/{property_name}{
"name": "<string>",
"label": "<string>",
"description": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"options": [
{
"description": "<string>",
"label": "<string>",
"value": "<string>",
"displayOrder": 123,
"hidden": true,
"readOnly": true,
"doubleData": 123
}
],
"displayOrder": 123,
"formField": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"hidden": true,
"mutableDefinitionNotDeletable": true,
"favorited": true,
"favoritedOrder": 123,
"calculated": true,
"externalOptions": true,
"displayMode": "<string>",
"createdUserId": 123,
"updatedUserId": 123
}Get a Company Property
Get a specific company property by its (internal) name.
curl --request GET \
--url https://api.hubapi.com/properties/v1/companies/properties/named/{property_name}{
"name": "<string>",
"label": "<string>",
"description": "<string>",
"groupName": "<string>",
"type": "string",
"fieldType": "textarea",
"options": [
{
"description": "<string>",
"label": "<string>",
"value": "<string>",
"displayOrder": 123,
"hidden": true,
"readOnly": true,
"doubleData": 123
}
],
"displayOrder": 123,
"formField": true,
"readOnlyValue": true,
"readOnlyDefinition": true,
"hidden": true,
"mutableDefinitionNotDeletable": true,
"favorited": true,
"favoritedOrder": 123,
"calculated": true,
"externalOptions": true,
"displayMode": "<string>",
"createdUserId": 123,
"updatedUserId": 123
}Pfadparameter
The API name of the property that you wish to see metadata for.
Antwort
Successful response with company property details
The internal name of the property
A human readable label for the property
A description of the property
The property group that the property belongs to
The data type that the property stores
string, number, date, datetime, enumeration Controls how the property appears in the HubSpot app
textarea, text, date, number, select, radio, checkbox, booleancheckbox Options for enumeration properties
Show child attributes
Show child attributes
Used to control the default order of the property within the property group
Whether the property can be used in forms
Whether the property value is read-only
Whether the property definition is read-only
Whether the property is hidden
Whether the property definition can be deleted
Whether the property is favorited
The order of the property in the favorites list
Whether the property is calculated
Whether the property uses external options
The display mode of the property
The ID of the user who created the property
The ID of the user who last updated the property