There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get a Company Property

Last updated May 15, 2023

GET /properties/v1/companies/properties/named/:property_name

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

crm.schemas.companies.read

Get a specific company property by its (internal) name.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Property Name Used in the request URL The API name of the property that you wish to see metadata for.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/properties/v1/companies/properties/named/an_example_property Example JSON response: { "name": "an_example_property", "label": "An Example Property", "description": "", "groupName": "companyinformation", "type": "enumeration", "fieldType": "checkbox", "updatedUserId": 100097, "deleted": false, "options": [ { "description": null, "label": "First", "displayOrder": 0, "hidden": false, "readOnly": null, "doubleData": null, "value": "first" }, { "description": null, "label": "Second", "displayOrder": 1, "hidden": false, "readOnly": null, "doubleData": null, "value": "second" }, { "description": null, "label": "Third", "displayOrder": 2, "hidden": false, "readOnly": null, "doubleData": null, "value": "third" }, { "description": null, "label": "Fourth", "displayOrder": 3, "hidden": false, "readOnly": null, "doubleData": null, "value": "fourth" }, { "description": null, "label": "Last", "displayOrder": 4, "hidden": false, "readOnly": null, "doubleData": null, "value": "last" } ], "formField": true, "displayOrder": 50, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value", "createdUserId": 100097 }