Roles
Agency Key is required to access this resource.
The roles resource allows you to retrieve user roles.
Roles Instance Resources
| Method | Endpoint | Description |
| GET | /api/v1/roles | Get a paginated list of details for all roles. |
| GET | /api/v1/roles/{role_id} | Get details about a single role. |
Get All Roles
Get a paginated list of details for all roles.
Resource Details
| Method | Endpoint |
| GET | https://app.whatconverts.com/api/v1/roles |
Supported Parameters
| Parameter | Type | Description | Required |
roles_per_page | number | Number of roles to return for this request (default 25, maximum 250). | No |
page_number | number | Page number to return for this request. | No |
order | string | Order in which to return the roles by name; (default) asc or desc. | No |
role_type | string | Role type to return for this request; (default) master_account or account user. | No |
Response Details
| Parameter | Type | Description |
roles_per_page | number | The number of roles returned in the request. |
page_number | number | The current page number in the request. |
total_pages | number | The total amount of pages available in the request. |
total_roles | number | The total amount of roles available in the request. |
roles | array | Contains all the requested roles. |
role_id | number | Unique identifier for the role. |
role_type | string | The type of role. master_account_role or account_role |
role_name | string | The name of the role. |
Example Response
{
"page_number": 1,
"roles_per_page": 25,
"total_pages": 2,
"total_roles": 45,
"roles": [
{
"role_id": 42390328,
"role_type": "master_account_role",
"role_name": "Administrator"
},
...
]
}
Get Single Role
Get details for specific role.
Resource Details
| Method | Endpoint |
| GET | https://app.whatconverts.com/api/v1/roles/{role_id} |
Supported Parameters
No supported parameters.
Response Details
| Parameter | Type | Description |
roles_per_page | number | The number of roles returned in the request. |
page_number | number | The current page number in the request. |
total_pages | number | The total amount of pages available in the request. |
total_roles | number | The total amount of roles available in the request. |
roles | array | Contains all the requested roles. |
role_id | number | Unique identifier for the role. |
role_type | string | The type of role. master_account_role or account_role |
role_name | string | The name of the role. |
lead_notifications | boolean | If the role is able to receive lead notifications. | permissions | object | Permissions for this role. |
integrations | string | Permissions for integrations. none, view or edit. |
leads | string | Permissions for leads. none, view or edit. |
profiles | string | Permissions for profiles. none, view or edit. |
reports | string | Permissions for reports. none, view or edit. |
settings | string | Permissions for settings. none, view or edit. |
tracking | string | Permissions for tracking. none, view or edit. |
accounts | string | Permissions for accounts. none, view or edit. Applicable to master_account roles. |
billing | string | Permissions for billing. none, view or edit. Applicable to master_account roles. |
security | string | Permissions for security. none, view or edit. Applicable to master_account roles. |
users | string | Permissions for users. none, view or edit. Applicable to master_account roles. |
Example Response
{
"page_number": 1,
"roles_per_page": 1,
"total_pages": 1,
"total_roles": 1,
"users": [
{
"role_id": 42390328,
"role_type": "master_account_role",
"role_name": "Administrator"
"lead_notifications": true,
"permissions": {
"integrations": "edit",
"leads": "edit",
"profiles": "edit",
"reports": "edit",
"settings": "edit",
"tracking": "edit",
"accounts": "edit",
"billing": "edit",
"security": "edit",
"users": "edit"
}
}
]
}
Get a FREE presentation of WhatConverts
One of our marketing experts will give you a full presentation of how WhatConverts can help you grow your business.
Schedule a Demo
