API Documentation - Users

Users Instance Resources

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.
POST	/api/v1/users/	Create a new user.
POST	/api/v1/users/	Editing user.

Get All Users

Get a paginated list of details for all users.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/users

Supported Parameters

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

Response Details

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_user`.
	`role_id`	number	Unique identifier for the master account role for the user. Applicable to `master_account_user`.

Example Response

    {
	  "page_number": 1,
	  "users_per_page": 25,
	  "total_pages": 2,
	  "total_users": 45,
	  "users": [
		{
		  "user_id": 5411295,
		  "user_type": "master_account_user",
		  "email": "jeremy@whatconverts.com",
		  "pending_activation": false,
		  "date_created": "2016-06-24T17:24:42Z",
		  "role_name": "Administrator",
		  "role_id": 349981
		},
		...
	  ]
	}

Get Single User

Get details for specific user.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/users/{user_id}

Supported Parameters

No supported parameters.

Response Details

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_user`.
	`role_id`	number	Unique identifier for the master account role for the user. Applicable to `master_account_user`.
`new_account_notifications`		object	Notification settings for new accounts for the user. Applicable to `master_account_user`.
	`reports`	boolean	New account notification for reports. Applicable to `master_account_user`.
	`phone_calls`	boolean	New account notification for phone calls. Applicable to `master_account_user`.
	`web_forms`	boolean	New account notification for web forms. Applicable to `master_account_user`.
	`transactions`	boolean	New account notification for transactions. Applicable to `master_account_user`.
	`events`	boolean	New account notification for events. Applicable to `master_account_user`.
	`chats`	boolean	New account notification for chats. Applicable to `master_account_user`.
	`emails`	boolean	New account notification for emails. Applicable to `master_account_user`.
	`other`	boolean	New account notification for other. Applicable to `master_account_user`.
	`text_messages`	boolean	New account notification for text_message. Applicable to `master_account_user`.
`accounts`		array	Notification settings for accounts for the user. Applicable to `account_user`.
	`account_id`	number	Unique identifier for the account. Applicable to `account_user`.
	`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.

Example Response

    {
	  "page_number": 1,
	  "users_per_page": 1,
	  "total_pages": 1,
	  "total_users": 1,
	  "users": [
		{
		  "user_id": 5411295,
		  "user_type": "master_account_user",
		  "email": "jeremy@whatconverts.com",
		  "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,
			  }
			},
			...
		  ]
		}
	  ]
	}

Create a New User

The body of the request must contain a JSON object with the following fields

Resource Details

Method	Endpoint
POST	https://app.whatconverts.com/api/v1/users

Supported Parameters

Parameter		Type	Description	Required
`user_type`		string	The user type; `master_account_user` or `account_user`.	Yes
`email`		string	The user email address.	Yes
`role_id`		integer	Unique identifier of the role. Applicable to `master_account_user`.	No
`new_account_notifications`		array	The user new account notifications. Applicable to `master_account_user`.	No
	`chats`	boolean	New account notification for chats. Applicable to `master_account_user`.	No
	`emails`	boolean	New account notification for emails. Applicable to `master_account_user`.	No
	`events`	boolean	New account notification for events. Applicable to `master_account_user`.	No
	`other`	boolean	New account notification for other. Applicable to `master_account_user`.	No
	`phone_calls`	boolean	New account notification for phone calls. Applicable to `master_account_user`.	No
	`text_messages`	boolean	New account notification for text messages. Applicable to `master_account_user`.	No
	`transactions`	boolean	New account notification for transactions. Applicable to `master_account_user`.	No
	`web_forms`	boolean	New account notification for web forms. Applicable to `master_account_user`.	No
	`reports`	boolean	New account notification for reports. Applicable to `master_account_user`.	No
`accounts`		array	If `account_user`, accounts the user has access to, the role and notification settings. If `master_account_user`, accounts the user has access to and notification settings.	No
	`account_id`	integer	Unique identifier for the account.	No
	`role_id`	integer	Unique identifier for the role. Applicable to `account_user`.	No
	`chats`	boolean	Account notification for chats.	No
	`emails`	boolean	Account notification for emails.	No
	`events`	boolean	Account notification for events.	No
	`other`	boolean	Account notification for other.	No
	`phone_calls`	boolean	Account notification for phone calls.	No
	`text_messages`	boolean	Account notification for text messages.	No
	`transactions`	boolean	Account notification for transactions.	No
	`web_forms`	boolean	Account notification for web forms.	No
	`reports`	boolean	Account notification for reports.	No

Example Request

  {
		"user_type": "master_account_user",
	    "email": "my_email_address@my_domain.com",
	    "role_id": 31425,
	    "new_account_notifications": {
	        "chats": false,
	        "emails": false,
	        "events": false,
	        "other": true,
	        "phone_calls": true,
	        "text_messages": true,
	        "transactions": false,
	        "web_forms": false,
	        "reports": true
	    },
	    "accounts": [
	        {
	            "account_id": 3865709,
	            "reports": true,
	            "phone_calls": false,
	            "web_forms": false,
	            "transactions": false,
	            "events": false,
	            "chats": false,
	            "emails": false,
	            "other": false,
	            "text_messages": false
	        },
	        {
	            "account_id": 3865710,
	            "reports": true
	        }
	    ]
	}

Example Response

  {
	"user_id": 63752,
	"user_type": "master_account_user",
	"email": "my_email_address@my_domain.com",
	"pending_activation": true,
	"date_created": "2022-08-19T18:18:02Z",
	"role_id": 34125,
	"role_name": "Auditor"
}

Edit an existing user

The body of the request must contain a JSON object with the following fields

Resource Details

Method	Endpoint
POST	https://app.whatconverts.com/api/v1/users

Supported Parameters

Parameter		Type	Description	Required
`user_id`		integer	Unique identifier for the user.	Yes
`role_id`		integer	Unique identifier of the role. Applicable to `master_account_user`.	No
`new_account_notifications`		array	The user new account notifications. Applicable to `master_account_user`.	No
	`chats`	boolean	New account notification for chats. Applicable to `master_account_user`.	No
	`emails`	boolean	New account notification for emails. Applicable to `master_account_user`.	No
	`events`	boolean	New account notification for events. Applicable to `master_account_user`.	No
	`other`	boolean	New account notification for other. Applicable to `master_account_user`.	No
	`phone_calls`	boolean	New account notification for phone calls. Applicable to `master_account_user`.	No
	`text_messages`	boolean	New account notification for text messages. Applicable to `master_account_user`.	No
	`transactions`	boolean	New account notification for transactions. Applicable to `master_account_user`.	No
	`web_forms`	boolean	New account notification for web forms. Applicable to `master_account_user`.	No
	`reports`	boolean	New account notification for reports. Applicable to `master_account_user`.	No
`accounts`		array	If `account_user`, accounts the user has access to, the role and notification settings. If `master_account_user`, accounts the user has access to and notification settings.	No
	`account_id`	integer	Unique identifier for the account.	Yes
	`role_id`	integer	Unique identifier for the role. Set `role_id` to `false` to remove access. Applicable to `account_user`.	No
	`chats`	boolean	Account notification for chats.	No
	`emails`	boolean	Account notification for emails.	No
	`events`	boolean	Account notification for events.	No
	`other`	boolean	Account notification for other.	No
	`phone_calls`	boolean	Account notification for phone calls.	No
	`text_messages`	boolean	Account notification for text messages.	No
	`transactions`	boolean	Account notification for transactions.	No
	`web_forms`	boolean	Account notification for web forms.	No
	`reports`	boolean	Account notification for reports.	No

Example Request

  {
		"user_id": 31425,
		"accounts": [
		    {
		    	"account_id": 3865709,
		    	"role_id": 271,
		    	"reports": true,
		    	"phone_calls": false,
		    	"web_forms": false,
		    	"transactions": false
		    },
		    {
		    	"account_id": 3865800,
		    	"role_id": false
		    }
		]
	}

Example Response

  {
	"user_id": 31425,
	"email": "my_email_address@my_domain.com",
	"accounts": [
		{
			"account_id": 3865709,
			"account_name": "My Account",
			"role_id": 271,
			"role_name": "Standard"
		}
	]
}