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.
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.json format):

{"result_ok": true,"total_count": 29,"page": 1,"total_pages": 1,"results_per_page": 29,"data": [{"id": "123456","username": "Username","email": "user@test.com","admin": 0,"phone_support": 0,"userdata": [],"license": "","defaultteam": false,"status": "Active","last_login": null,"api_key": null,"api_secret": null},{"id": "123457","username": "Username","email": "first.last@surveygizmo.com","admin": 0,"phone_support": 0,"userdata": [{"id": "75","name": "Course","description": "This is the course that this user teaches ","value": ""},{"id": "76","name": "Department","description": "User's department in the organization","value": ""}],"license": "Full Access","defaultteam": "","status": "Active","last_login": null,"api_key": null,"api_secret": 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=abcd12345&api_token_secret=abcd12345
True

Response Example (.json format):

{"result_ok": true,"data": {"id": "164314","username": "test","email": "user@test.com","admin": 0,"phone_support": 0,"userdata": [],"license": "","defaultteam": false,"status": "Active","last_login": null,"api_key": null,"api_secret": 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=abcd12345&api_token_secret=abcd12345
True
emailjohn@email.comTrue
passwordsecure123False
usernameJane DoeFalse
team23454 (Team ID)False
defaultteam23454 (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": "164314","username": "test","email": "user@test.com","admin": 0,"phone_support": 0,"userdata": [],"license": "","defaultteam": false,"status": "Active","last_login": null,"api_key": null,"api_secret": null}}

UPDATE ACCOUNTUSER - Update/Change user information.

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

ParametersValue/ExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
emailjohn@email.comFalse
passwordsecure123False
usernameJane DoeFalse
team23454 (Team ID)False
defaultteam23454 (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": "164314","username": "test","email": "user@test.com","admin": 0,"phone_support": 0,"userdata": [],"license": "","defaultteam": false,"status": "Active","last_login": null,"api_key": null,"api_secret": null}}

DELETE ACCOUNTUSER - Delete specific user from  your account.

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

ParametersValue/ExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.json format):

{"result_ok": true,"data": {"id": "164314","username": "test","email": "user@test.com","admin": 0,"phone_support": 0,"userdata": [],"license": "","defaultteam": false,"status": "Disabled","last_login": null,"api_key": null,"api_secret": null}}