AccountUser Object v5

 Help Us Improve Our API Documentation!

We're beginning an initiative to improve our API docs. We would love your help!

Please take this quick 4-question survey to help us out! Thank you in advance for your time!

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.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
pagepage=3False
resultsperpageresultsperpage=100False

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.
ParametersExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

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

ParametersValue/ExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
emailjohn@email.comTrue
passwordsecure123False
usernameJane DoeFalse
team23454 (Team ID)False
admin1,0False
phone_support1,0False
licenseFull Access, Reporting, Market Research, Educational, HR Professional, Basic, StandardFalse
create_access_tokentrue (only allowed when using oath)False
userdata[column_name]userdata[department]=salesFalse

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

ParametersValue/ExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True
emailjohn@email.comFalse
passwordsecure123False
usernameJane DoeFalse
team23454 (Team ID)False
admin1,0False
phone_support1,0False
licenseFull Access, Reporting, Market Research, Educational, HR Professional, Basic, StandardFalse
userdata[column_name]userdata[department]=salesFalse

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

ParametersValue/ExampleRequired
Authentication Credentialsapi_token=5D685159B6964FB69B044D3E7D2676D1True

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
 }
}