Get all contact properties

Last updated December 30, 2019

GET /properties/v1/contacts/properties

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

Contact properties are fields that store information about a contact record. This endpoint is used to retrieve all contact properties in a HubSpot account, including all default properties and any custom contact properties that have been created for the account.

Use case for this endpoint: A synchronizing integration could use this method to understand what kind of information it needs to stay up-to-date.

Required parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.

Example URL:  https://api.hubapi.com/properties/v1/contacts/properties?hapikey=demo

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?hapikey=demo Example JSON output: [ { "name": "example_property_name", "label": "Example Property Name", "description": "Example Description of the property", "groupName": "contactinformation", "type": "string", "fieldType": "text", "options": [ ], "deleted": false, "displayOrder": -1, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value", "formField": true }, { "name": "first_deal_created_date", "label": "First Deal Created Date", "description": "The date the first deal for a contact was created. This is automatically set by HubSpot and can be used for segmentation and reporting.", "groupName": "contactinformation", "type": "datetime", "fieldType": "text", "options": [ ], "displayOrder": -1, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true, "formField": false }, { "name": "hs_email_sends_since_last_engagement", "label": "Sends Since Last Engagement", "description": "This property tracks how many marketing emails have been sent to a contact since they last engaged with one.", "groupName": "emailinformation", "type": "number", "fieldType": "text", "options": [ ], "displayOrder": -1, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "favorited": false, "favoritedOrder": -1, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true, "formField": false }, //... ]
import requests import json url= 'https://api.hubapi.com/properties/v1/contacts/properties?hapikey=demo' r=requests.get(url=url) print(r.text)
var request = require("request"); var options = { method: 'GET', url: 'https://api.hubapi.com/properties/v1/contacts/properties', qs: { hapikey: 'demo' } } request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });