Hi,
Greetings for the day.
Is there any way where I can get access to Permission API. I am already using Starter pack and Marketing hub is on trail. Just wanted to check If I upgrade my account to Enterprise edition, will I be able to get Permission API.
Thanks
Hi @VVarshney,
The user provisioning / users API should be accessible on a Starter subscription already: Accounts Dashboard | HubSpot
Is there something specific that’s not working for you right now?
If you’re referring to permission sets specifically, correct, that would require any Enterprise subscription: Create and assign permission sets
Best regards
Hi @karstenkoehler ,
With user provisioning api also, I am not able to retrieve user permissions. It is providing me user details but not permissions.
I want to retrieve user permissions via API.
The document link which you have provided I can see that it is through UI.
If you can help me out with this, it would be great!
Thanks!
@VVarshney which endpoint exactly are you using? Which status code / response are you getting?
I am using this endpoint-
https://api.hubapi.com/crm/v3/objects/users
Response: {
“id”: “373077915434”,
“properties”: {
“hs_createdate”: “2024-10-14T07:24:56.629Z”,
“hs_lastmodifieddate”: “2024-10-16T04:51:06.886Z”,
“hs_object_id”: “373077915434”
},
“createdAt”: “2024-10-14T07:24:56.629Z”,
“updatedAt”: “2024-10-16T04:51:06.886Z”,
“archived”: false
},
Here I want to retrieve user permissions.
I tried with Teams and Owner API too.
Thanks!
@VVarshney I’m not sure I’m following - which exact endpoint are you using and what request are you making? Accounts Dashboard | HubSpot
GET /settings/v3/users/
POST /settings/v3/user/
…?
Maybe there is also a misunderstanding about “retrieving user permissions”, what exactly are you expecting in the response?
Hi @karstenkoehler ,
Actually I want to get info about user roles and permissions.
The endpoint which you mentioned is returning static data only i.e. It is only returning one permission. But I want to get all the roles and permissions which particular user have.
I hope that I am able to make you understand my point.
Thankyou.
@VVarshney a user can only have one role. Can you give me an example?
Let me explain with an example:
I have created a user named Vaishali Varshney and have assigned CMS developer permission set to this user. It is having access such as Account, contacts and marketing.
Now, I want to retrieve this information via API.
So how can I do it?
I hope that you are able to understand my point.
Thankyou.
@VVarshney I might be missing something but as far as I can tell, there isn’t any endpoint which would give you that information.
Hi @karstenkoehler ,
So if we upgrade our account to Enterprise edition, will we be able to fetch these details?
Like is there any way through which we can get these details via API.
Thankyou.
@VVarshney no, I don’t see how the Enterprise subscription level would change that.
Hi @karstenkoehler ,
So correct me If I am wrong, There is no way to fetch user permissions or details from the given APIs in the document.
Even enterprise edition won’t help in getting those details.
There is no such API available in the open source.
Thanks!
@VVarshney as far as I can tell from the API documentation, correct.
Hi @karstenkoehler ,
If not API, is there any other way through which we can retreive those details. Can we try it via DB?
Note that we have tried connecting it with CData but didn’t got any of the details.
Thankyou.
Hi @karstenkoehler ,
Is there any document where it is mentioned that there is no way to retrieve the user role and permissions?
Thankyou.
@VVarshney I’m not seeing it in the Endpoints tab on these two pages:
It’s not going to specify that something is not available – instead it’s simply not going to be a listed endpoint. If it’s not listed, then as far as I can tell, it’s not available.
Hi @karstenkoehler ,
I have found Permission API from Hubspot Network but that API is available on version 1.
Endpoint reference- https://app.hubspot.com/api/app-users/v1/users?portalId=42592887&clienttimeout=14000&hs_static_app=settings-ui-users&hs_static_app_version=1.46494
Could you please let me know if this API is depreciated or not?
Thankyou.
@VVarshney I can’t find anything in the documentation about this endpoint. If you want to check whether this is deprecated, I’d recommend with HubSpot support.
@VVarshney there’s an update here, a private beta which you can find under Settings > Product updates > All updates. (If it’s not there, you’ll have to be patient a bit longer until it exits private beta status.)
APIs
Public Permissions API
January 21, 2025
What is it?
We’ve introduced an API that returns a list of users with access to a specific object ID.
Why does it matter?
This update supports those who want to know what users have access to each object, so that HubSpot data can be better leveraged in products.
How does it work?
The primary exposed endpoint is the “Permitted Users” endpoint, which given a list of resources in the form of HCRNs (spec below) responds with a list of actions and permitted user ids for those actions. Initially this will only support CRM objects.
Example:
----
{
“resources”: {
“hcrn:48344777:crm-object:0-3:29672272530”: {
“crm-object:COMMUNICATE”: {
“action”: “crm-object:COMMUNICATE”,
“permittedUsers”: [74855373,74855416,74954882 ]
},
“crm-object:EDIT”: {
“action”: “crm-object:EDIT”,
“permittedUsers”: [74855373,74855416,74954882]
},
“crm-object:VIEW”: {
“action”: “crm-object:VIEW”,
“permittedUsers”: [74855373,74855416,74954882]
},
“crm-object:DELETE”: {
“action”: “crm-object:DELETE”,
“permittedUsers”: [74855373,74855416,74954882]
}
}
}
}
----
HCRN Spec:
hcrn:<portalId>:<resourceType>:[resourceTypeId]:[resourceId]/[subResource]
For CRM objects the subResource is unused and should be omitted. The portalId should be self explanatory. The resourceType will always be “crm-object”. The resourceTypeId is the object type ID and the resourceId is the object ID.
Example:
hcrn:48344777:crm-object:0-3:29672272530
Who gets it?
All Hubs and Editions