API for Developers
API for Developers
Join 20,000+ other marketers and start getting marketing clarity

Subscribe to our newsletter and get proven marketing strategies for growing your business.

    Suggested Blog Articles
    Easy Keyword Level Call Tracking
    Marketing Easy Keyword Level Call Tracking

    Last update on Jun 4, 2015

    Users

    The users resource allows you to retrieve users.

    Users Instance Resources

    MethodEndpointDescription
    GET/api/v1/usersGet 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

    MethodEndpoint
    GEThttps://app.whatconverts.com/api/v1/users

    Supported Parameters

    ParameterTypeDescriptionRequired
    users_per_pagenumberNumber of users to return for this request (default 25, maximum 250).No
    page_numbernumberPage number to return for this request.No
    start_datestringStart date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
    end_datestringEnd date for this request in date or date/time ISO 8601 format (UTC); 2015-11-10 or 2015-11-10T00:00:00Z.No
    orderstringOrder in which to return the users by date created; asc or (default) desc.No
    user_typestringUser type to return for this request; (default) master_account or account user.No

    Response Details

    ParameterTypeDescription
    users_per_pagenumberThe number of users returned in the request.
    page_numbernumberThe current page number in the request.
    total_pagesnumberThe total amount of pages available in the request.
    total_usersnumberThe total amount of users available in the request.
    usersarrayContains all the requested users.
    user_idnumberUnique identifier for the user.
    user_typestringThe type of user. master_account_user or account_user.
    emailstringThe email of user.
    pending_activationbooleanIf the user is pending activation.
    role_namestringThe master account role name for the user. Applicable to master_account_user.
    role_idnumberUnique 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

    MethodEndpoint
    GEThttps://app.whatconverts.com/api/v1/users/{user_id}

    Supported Parameters

    No supported parameters.

    Response Details

    ParameterTypeDescription
    users_per_pagenumberThe number of users returned in the request.
    page_numbernumberThe current page number in the request.
    total_pagesnumberThe total amount of pages available in the request.
    total_usersnumberThe total amount of users available in the request.
    usersarrayContains all the requested users.
    user_idnumberUnique identifier for the user.
    user_typestringThe type of user. master_account_user or account_user.
    emailstringThe email of user.
    pending_activationbooleanIf the user is pending activation.
    role_namestringThe master account role name for the user. Applicable to master_account_user.
    role_idnumberUnique identifier for the master account role for the user. Applicable to master_account_user.
    new_account_notificationsobjectNotification settings for new accounts for the user. Applicable to master_account_user.
    reportsbooleanNew account notification for reports. Applicable to master_account_user.
    phone_callsbooleanNew account notification for phone calls. Applicable to master_account_user.
    web_formsbooleanNew account notification for web forms. Applicable to master_account_user.
    transactionsbooleanNew account notification for transactions. Applicable to master_account_user.
    eventsbooleanNew account notification for events. Applicable to master_account_user.
    chatsbooleanNew account notification for chats. Applicable to master_account_user.
    emailsbooleanNew account notification for emails. Applicable to master_account_user.
    otherbooleanNew account notification for other. Applicable to master_account_user.
    text_messagesbooleanNew account notification for text_message. Applicable to master_account_user.
    accountsarrayNotification settings for accounts for the user. Applicable to account_user.
    account_idnumberUnique identifier for the account. Applicable to account_user.
    account_namestringThe name of the account. Applicable to account users.
    notificationsobjectNotification settings for the account for the user.
    reportsbooleanAccount notification for reports.
    phone_callsbooleanAccount notification for phone calls.
    web_formsbooleanAccount notification for web forms.
    transactionsbooleanAccount notification for transactions.
    eventsbooleanAccount notification for events.
    chatsbooleanAccount notification for chats.
    emailsbooleanAccount notification for emails.
    otherbooleanAccount notification for other.
    text_messagesbooleanAccount 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

    MethodEndpoint
    POSThttps://app.whatconverts.com/api/v1/users

    Supported Parameters

    ParameterTypeDescriptionRequired
    user_typestringThe user type; master_account_user or account_user.Yes
    emailstringThe user email address.Yes
    role_idintegerUnique identifier of the role. Applicable to master_account_user.No
    new_account_notificationsarrayThe user new account notifications. Applicable to master_account_user.No
    chatsbooleanNew account notification for chats. Applicable to master_account_user.No
    emailsbooleanNew account notification for emails. Applicable to master_account_user.No
    eventsbooleanNew account notification for events. Applicable to master_account_user.No
    otherbooleanNew account notification for other. Applicable to master_account_user.No
    phone_callsbooleanNew account notification for phone calls. Applicable to master_account_user.No
    text_messagesbooleanNew account notification for text messages. Applicable to master_account_user.No
    transactionsbooleanNew account notification for transactions. Applicable to master_account_user.No
    web_formsbooleanNew account notification for web forms. Applicable to master_account_user.No
    reportsbooleanNew account notification for reports. Applicable to master_account_user.No
    accountsarrayIf 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_idintegerUnique identifier for the account.No
    role_idintegerUnique identifier for the role. Applicable to account_user.No
    chatsbooleanAccount notification for chats.No
    emailsbooleanAccount notification for emails.No
    eventsbooleanAccount notification for events.No
    otherbooleanAccount notification for other.No
    phone_callsbooleanAccount notification for phone calls.No
    text_messagesbooleanAccount notification for text messages.No
    transactionsbooleanAccount notification for transactions.No
    web_formsbooleanAccount notification for web forms.No
    reportsbooleanAccount 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

    MethodEndpoint
    POSThttps://app.whatconverts.com/api/v1/users

    Supported Parameters

    ParameterTypeDescriptionRequired
    user_idintegerUnique identifier for the user.Yes
    role_idintegerUnique identifier of the role. Applicable to master_account_user.No
    new_account_notificationsarrayThe user new account notifications. Applicable to master_account_user.No
    chatsbooleanNew account notification for chats. Applicable to master_account_user.No
    emailsbooleanNew account notification for emails. Applicable to master_account_user.No
    eventsbooleanNew account notification for events. Applicable to master_account_user.No
    otherbooleanNew account notification for other. Applicable to master_account_user.No
    phone_callsbooleanNew account notification for phone calls. Applicable to master_account_user.No
    text_messagesbooleanNew account notification for text messages. Applicable to master_account_user.No
    transactionsbooleanNew account notification for transactions. Applicable to master_account_user.No
    web_formsbooleanNew account notification for web forms. Applicable to master_account_user.No
    reportsbooleanNew account notification for reports. Applicable to master_account_user.No
    accountsarrayIf 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_idintegerUnique identifier for the account.Yes
    role_idintegerUnique identifier for the role. Set role_id to false to remove access. Applicable to account_user.No
    chatsbooleanAccount notification for chats.No
    emailsbooleanAccount notification for emails.No
    eventsbooleanAccount notification for events.No
    otherbooleanAccount notification for other.No
    phone_callsbooleanAccount notification for phone calls.No
    text_messagesbooleanAccount notification for text messages.No
    transactionsbooleanAccount notification for transactions.No
    web_formsbooleanAccount notification for web forms.No
    reportsbooleanAccount 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"
    		}
    	]
    }
    
    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
    Whatconverts Features for your Business
    Leads by Week
    Analytics & Insights Leads by Week

    WhatConverts can plot your leads over a period of time to show when the fluctuations happened. 

    Call Tracking Triggers
    Lead Tracking Call Tracking Triggers

    Choose which calls to track based on which marketing source the caller is coming from.

    Call Recording
    Lead Tracking Call Recording

    Control, download and monitor your incoming calls at no additional cost.

    Add Value in Leads Dashboard
    Lead Management Add Value in Leads Dashboard

    As leads come in, they appear in your Leads Dashboard in WhatConverts where you can qualify and add sales value.

    Join 20,000+ other marketers and start getting marketing clarity

    Subscribe to our newsletter and get proven marketing strategies for growing your business.

      Suggested Blog Articles
      How to Measure Marketing Effectiveness in 2020
      Lead Tracking How to Measure Marketing Effectiveness in 2020

      Last update on Oct 24, 2019

      ready to get marketing clarity?

      Grow your business with WhatConverts

      14 days free trial Easy setup Dedicated support
      G2 Users Love Us Badge
      G2 High Performer Badge
      G2 High Performer Small Business Badge
      G2 Momentum Leader Badge
      G2 High Performer Europe Badge