Reminder: As of August 9th, the demo API key will only be allowed to make GET requests. Please see the announcement for more details.

Get Contact Property Group Details

Last updated March 18, 2019

GET /properties/v1/contacts/groups/named/:groupName

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

Get property group information and optionally get all the contact properties in a property group. Property groups allow you to more easily manage properties in a given HubID and make contact records easier to parse for the user. If your integration is creating contact properties, it's a good practice to create a new property group to include all of the properties you create.

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.
Group Name Used in the request URL The internal name of the property group. The name must be used whenever the group is referenced using the API.
Optional Parameters How to use Description
includeProperties &includeProperties=true - Used in the request URL Set this parameter to true if you want the response to include the definitions of the properties in the group. Exclude this parameter if you only want the property group info.