Roles
Roles are a part of the Visibility groups’ feature that allow the admin user to categorize other users and dictate what items they will be allowed access to see.
Get all roles
/v1/roles
Query parameters
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
Get all roles
Expand all
Copy code- true
- [ ... ]▶
- { ... }▶
Get one role
/v1/roles/{id}
Path parameters
id
integer
required
The ID of the role
Response
Get one role
Expand allCopy code- true
- { ... }▶
- { ... }▶
List role assignments
/v1/roles/{id}/assignments
Lists assignments for a role.
Path parameters
id
integer
required
The ID of the role
Query parameters
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
List assignments for a role
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
List role sub-roles
/v1/roles/{id}/roles
Path parameters
id
integer
required
The ID of the role
Query parameters
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
Response
List role sub-roles
Expand allCopy code- true
- [ ... ]▶
- { ... }▶
List role settings
/v1/roles/{id}/settings
Path parameters
id
integer
required
The ID of the role
Response
List role settings
Expand allCopy code- true
- { ... }▶
Add a role
/v1/roles
Body parameters
application/x-www-form-urlencoded
parent_role_id
integer
The ID of the parent role
name
string
The name of the role
Response
Add a role
Expand allCopy code- true
- { ... }▶
Add role assignment
/v1/roles/{id}/assignments
Adds assignment for a role.
Path parameters
id
integer
required
The ID of the role
Body parameters
application/x-www-form-urlencoded
user_id
integer
required
The ID of the user
Response
Add assignment for a role
Expand allCopy code- true
- { ... }▶
Add or update role setting
/v1/roles/{id}/settings
Adds or updates the visibility setting for a role.
Path parameters
id
integer
required
The ID of the role
Body parameters
application/x-www-form-urlencoded
setting_key
string
required
Values
deal_default_visibility
lead_default_visibility
org_default_visibility
person_default_visibility
product_default_visibility
value
integer
required
Possible values for the default_visibility setting depending on the subscription plan:
| Value | Description |
|---|---|
1 | Owner & Followers |
3 | Entire company |
| Value | Description |
|---|---|
1 | Owner only |
3 | Owner's visibility group |
5 | Owner's visibility group and sub-groups |
7 | Entire company |
Read more about visibility groups here.
Values
1
3
5
7
Response
List role settings
Expand allCopy code- true
- { ... }▶
Update role details
/v1/roles/{id}
Path parameters
id
integer
required
The ID of the role
Body parameters
application/x-www-form-urlencoded
parent_role_id
integer
The ID of the parent role
name
string
The name of the role
Response
Update role details
Expand allCopy code- true
- { ... }▶
Delete a role
/v1/roles/{id}
Path parameters
id
integer
required
The ID of the role
Response
Delete a role
Expand allCopy code- true
- { ... }▶
Delete a role assignment
/v1/roles/{id}/assignments
Deletes assignment from a role.
Path parameters
id
integer
required
The ID of the role
Body parameters
application/x-www-form-urlencoded
user_id
integer
required
The ID of the user
Response
Delete assignment from a role
Expand allCopy code- true
- { ... }▶