Last modified: September 12, 2025
Run in Postman
HCRN format
The public permissions API uses the HCRN format for querying and displaying permissions based on the HubSpot account, CRM record type, and CRM record ID you’re requesting. This format always begins withhcrn:
, followed by the associated IDs you’re looking to query for:
ID | Description |
---|---|
accountId | The ID of the HubSpot account you want to query permission data from. |
resourceType | The category of resource you want to query permissions for. The only value currently supported is crm-object . |
resourceTypeId | The identifier for this resource type, e.g., an object type ID. You can find a full list of object type IDs here. |
resourceId | The ID of the specific instance of this resource (e.g., the ID of a specific contact). |
Please note:You can only currently query for permission to access contacts, companies, deals, and tickets.
Get user permissions for CRM records
To get user permissions for CRM record data in a HubSpot account, make aGET
request to /resource-permissions/v3/permitted-users?resource={hrcn}
, where the hcrn
matches the IDs and types you want to retrieve permission data for.
For example, if your HubSpot account ID was 123456
and you wanted to get user permissions for access to a contact with an ID of 64151
, you’d make a GET
request to /resource-permissions/v3/permitted-users?resource=hcrn:2086383:crm-object:0-1
The results would resemble the following: