There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get a contact property

Last updated May 15, 2023

GET /properties/v1/contacts/properties/named/:property_name

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.schemas.contacts.read

Contact properties store specific information for contact records. The get a contact property endpoint retrieves the details of a specific property set up for a HubSpot account. 

Use case for this endpoint: You have a lot of customer information that you want to see in HubSpot and other software systems. You can use the get a contact property endpoint to map a specific piece of customer information from HubSpot to your external system.

Response details

Returns a JSON object representing the definition for a given contact property.

 

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 the 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 URL: https://api.hubapi.com/properties/v1/contacts/properties/named/favorite_color Example JSON output: { "name": "favorite_color", "label": "", "description": "", "groupName": "contactinformation", "type": "enumeration", "fieldType": "", "options": [ { "description": null, "doubleData": null, "label": "Blue", "readOnly": null, "displayOrder": -1, "hidden": false, "value": "blue" }, { "description": null, "doubleData": null, "label": "Green", "readOnly": null, "displayOrder": -1, "hidden": false, "value": "green" }, { "description": null, "doubleData": null, "label": "Red", "readOnly": null, "displayOrder": -1, "hidden": false, "value": "red" }, { "description": null, "doubleData": null, "label": "Yellow", "readOnly": null, "displayOrder": -1, "hidden": false, "value": "yellow" }, { "description": null, "doubleData": null, "label": "Purple", "readOnly": null, "displayOrder": -1, "hidden": false, "value": "purple" } ], "deleted": false, "formField": false, "displayOrder": -1, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value" }