Subscribe to our newsletter and get proven marketing strategies for growing your business.
Last update on Mar 18, 2015
Agency Key is required to access this resource.
The users resource allows you to retrieve users.
Method | Endpoint | Description |
GET | /api/v1/users | Get a paginated list of details for all users. |
GET | /api/v1/users/{user_id} | Get details about a single user. |
Get a paginated list of details for all users.
Method | Endpoint |
GET | https://app.whatconverts.com/api/v1/users |
Parameter | Type | Description | Required |
users_per_page |
number | Number of users to return for this request (default 25, maximum 250). | No |
page_number |
number | Page number to return for this request. | No |
start_date |
string | Start date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z . |
No |
end_date |
string | End date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z . |
No |
order |
string | Order in which to return the users by date created; asc or (default) desc . |
No |
user_type |
string | User type to return for this request; (default) master_account or account user. |
No |
Parameter | Type | Description |
users_per_page |
number | The number of users 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_users |
number | The total amount of users available in the request. |
users |
array | Contains all the requested users. |
user_id |
number | Unique identifier for the user. |
user_type |
string | The type of user. master_account_user or account_user . |
email |
string | The email of user. |
pending_activation |
boolean | If the user is pending activation. |
role_name |
string | The master account role name for the user. Applicable to master_account users. |
role_id |
number | Unique identifier for the master account role for the user. Applicable to master_account users. |
{
"page_number": 1,
"users_per_page": 25,
"total_pages": 2,
"total_users": 45,
"users": [
{
"user_id": 5411295,
"user_type": "master_account_user",
"email": "[email protected]",
"pending_activation": false,
"date_created": "2016-06-24T17:24:42Z",
"role_name": "Administrator",
"role_id": 349981
},
...
]
}
Get details for specific user.
Method | Endpoint |
GET | https://app.whatconverts.com/api/v1/users/{user_id} |
No supported parameters.
Parameter | Type | Description |
users_per_page |
number | The number of users 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_users |
number | The total amount of users available in the request. |
users |
array | Contains all the requested users. |
user_id |
number | Unique identifier for the user. |
user_type |
string | The type of user. master_account_user or account_user . |
email |
string | The email of user. |
pending_activation |
boolean | If the user is pending activation. |
role_name |
string | The master account role name for the user. |
role_id |
number | Unique identifier for the master account role for the user. |
new_account_notifications |
object | Notification settings for new accounts for the user. Applicable to master_account users. |
reports |
boolean | New account notification for reports. Applicable to master_account users. |
phone_calls |
boolean | New account notification for phone calls. Applicable to master_account users. |
web_forms |
boolean | New account notification for web forms. Applicable to master_account users. |
transactions |
boolean | New account notification for transactions. Applicable to master_account users. |
events |
boolean | New account notification for events. Applicable to master_account users. |
chats |
boolean | New account notification for chats. Applicable to master_account users. |
emails |
boolean | New account notification for emails. Applicable to master_account users. |
other |
boolean | New account notification for other. Applicable to master_account users. |
text_messages |
boolean | New account notification for text_message. Applicable to master_account users. |
accounts |
array | Notification settings for accounts for the user. Applicable to account users. |
account_id |
number | Unique identifier for the account. Applicable to account users. |
account_name |
string | The name of the account. Applicable to account users. |
notifications |
object | Notification settings for the account for the user. |
reports |
boolean | Account notification for reports. |
phone_calls |
boolean | Account notification for phone calls. |
web_forms |
boolean | Account notification for web forms. |
transactions |
boolean | Account notification for transactions. |
events |
boolean | Account notification for events. |
chats |
boolean | Account notification for chats. |
emails |
boolean | Account notification for emails. |
other |
boolean | Account notification for other. |
text_messages |
boolean | Account notification for text_message. |
{
"page_number": 1,
"users_per_page": 1,
"total_pages": 1,
"total_users": 1,
"users": [
{
"user_id": 5411295,
"user_type": "master_account_user",
"email": "[email protected]",
"pending_activation": false,
"date_created": "2016-06-24T17:24:42Z",
"role_name": "Administrator",
"role_id": 349981,
"new_account_notifications": {
"reports": true,
"phone_calls": false,
"transactions": false,
"events": false,
"chats": false,
"emails": false,
"other": false,
"text_messages": false,
},
"accounts": [
{
"account_id": 83490437,
"account_name": "WhatConverts",
"notifications": {
"reports": true,
"phone_calls": false,
"transactions": false,
"events": false,
"chats": false,
"emails": false,
"other": false,
"text_messages": false,
}
},
...
]
}
]
}
One of our marketing experts will give you a full presentation of how WhatConverts can help you grow your business.
Get a 1:1 DemoRead details from your calls without the need to listen to the entire call recording.
Route calls to multiple destination numbers at once using multi-ring functionality.
Reroute calls that occur outside your active business times.
All incoming calls will be directed to the business location closest to the caller.
Subscribe to our newsletter and get proven marketing strategies for growing your business.
Last update on Mar 18, 2015