AccountUser Object v5

Note: The AccountUser Object is only accessible to Account Administrator users.

The following API calls are currently available for the AccountUser object:

GET LIST - Get a list of all users in your account.

https://restapi.surveygizmo.com/v5/accountuser

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
Parameters
Example
Required
Authentication Credentials
api_token=5D685159B6964FB69B044D3E7D2676D1
True
page
page=3
False
resultsperpage
resultsperpage=100
False

Response Example (.json format):

{
   "result_ok": true,
   "total_count": 13,
   "page": 1,
   "total_pages": 1,
   "results_per_page": 13,
   "data": [
      {
         "id": "156758",
         "username": "Jon Smith",
         "email": "jon.smith@company.com",
         "admin": 1,
         "phone_support": 0,
         "license": "Full Access",
         "status": "Active",
         "last_login": null
      },
      {
         "id": "156756",
         "username": "Jane Smith",
         "email": "jane.smith@company.com",
         "admin": 1,
         "phone_support": 1,
         "license": "Full Access",
         "status": "Active",
         "last_login": null
      }
   ]
}
	 

GET ACCOUNTUSER - Get information about a specific user in your account.

https://restapi.surveygizmo.com/v5/accountuser/[USERID]

Note: Get requests will cache for 60 seconds. If you make repeated API get requests that are identical, the return will be cached and will thus return identical results.
Parameters
Example
Required
Authentication Credentials
api_token=5D685159B6964FB69B044D3E7D2676D1
True

Response Example (.json format):


{
 "result_ok": true,
 "data": {
 "id": "156758",
 "username": "Jon Smith",
 "email": "jon.smith@company.com",
 "admin": 1,
 "phone_support": 0,
 "license": "Full Access",
 "status": "Active",
 "last_login": null
 }
}

CREATE ACCOUNTUSER - Create a new user in your account.

https://restapi.surveygizmo.com/v5/accountuser?_method=PUT&email=example@example.com

Parameters
Value/Example
Required
Authentication Credentials
api_token=5D685159B6964FB69B044D3E7D2676D1
True
email
john@email.com
True
password
secure123
False
username
Jane Doe
False
team
23454 (Team ID)
False
defaultteam
23454 (Team ID)
False
admin
1,0
False
phone_support
1,0
False
license
Full Access, Reporting, Market Research, Educational, HR Professional, Basic, Standard
False
create_access_token
true (only allowed when using oath)
False
userdata[column_name]
userdata[department]=sales
False

Response Example (.json format):


{
 "result_ok": true,
 "data": {
 "id": "156859",
 "username": "Jane Smith",
 "email": "jane.smith@company.com",
 "admin": 0,
 "phone_support": 0,
 "license": "",
 "status": null,
 "last_login": null
 }
}

UPDATE ACCOUNTUSER - Update/Change user information.

https://restapi.surveygizmo.com/v5/accountuser/123456?_method=POST

Parameters
Value/Example
Required
Authentication Credentials
api_token=5D685159B6964FB69B044D3E7D2676D1
True
email
john@email.com
False
password
secure123
False
username
Jane Doe
False
team
23454 (Team ID)
False
defaultteam
23454 (Team ID)
False
admin
1,0
False
phone_support
1,0
False
license
Full Access, Reporting, Market Research, Educational, HR Professional, Basic, Standard
False
userdata[column_name]
userdata[department]=sales
False

Example Response (.json format)


{
 "result_ok": true,
 "data": {
 "id": "156860",
 "username": "Jane Smith",
 "email": "jane.smith@company.com",
 "admin": 0,
 "phone_support": 1,
 "license": "",
 "status": "Active",
 "last_login": null
 }
}

DELETE ACCOUNTUSER - Delete specific user from  your account.

https://restapi.surveygizmo.com/v5/accountuser/123456?_method=DELETE

Parameters
Value/Example
Required
Authentication Credentials
api_token=5D685159B6964FB69B044D3E7D2676D1
True

Response Example (.json format):


{
 "result_ok": true,
 "data": {
 "id": "156860",
 "username": "Jane Smith",
 "email": "jane.smith@company.com",
 "admin": 0,
 "phone_support": 0,
 "license": "",
 "status": "Disabled",
 "last_login": null
 }
}