Understanding Roles API

[SPandey84]

Hi, 

I was checking Roles API to get role names and assigned permissions to it. On testing, I found that it is not working. 

Url-https://api.hubapi.com/settings/v3/roles

Is there any way to get what permissions are assigned to the user?

Thanks!

[Jigar_Thakker · Accepted solution]

Hi @SPandey84 ,

Yes, the endpoint you’re using (https://api.hubapi.com/settings/v3/roles) is correct. However, to ensure everything works smoothly, please follow these steps:

• Confirm that you are using the correct API key or OAuth token with sufficient permissions. Authentication issues can sometimes cause the request to fail.
• Verify that your request is properly structured according to the API specifications, including headers, parameters, and the HTTP method (GET).
• Once your request is successful, the response will include role details and their associated permissions. Review this data to understand the user's assigned permissions.

• If the endpoint isn’t returning the expected data, check the HTTP status codes in the response:
  - 403 Forbidden: You may lack the required access permissions.
  - 404 Not Found: The resource might not exist or be inaccessible.

• Ensure you review the HubSpot's API documentations. It provides detailed information about the endpoint, parameters, and authentication, helping confirm you’re using the API correctly. Here are few resources for your reference:
  - https://developers.hubspot.com/beta-docs/reference/api/overview
  - https://developers.hubspot.com/beta-docs/guides/api/overview

If you’re still encountering issues, double-check your authentication method, request setup, and endpoint usage. Testing the API with tools like Postman can also help troubleshoot.

I hope this resolves the issue! If this helps, feel free to mark it as the solution ✔️  and give it an upvote 👍!  Let me know if you have further questions.