AccountUser Object

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

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

https://restapi.surveygizmo.com/v4/accountuser
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True
pagepage=3False
resultsperpageresultsperpage=100False

Response Example (.debug format):


Array
(
 [result_ok] = 1
 [total_count] = 2
 [page] = 1
 [total_pages] = 1
 [results_per_page] = 2
 [data] = Array
 (
 [0] = Array
 (
 [id] = 000000
 [_type] = AccountUser
 [username] = John Doe
 [email] = johndoe@email.com
 [status] = Active
 [last_login] = 2012-12-08 15:33:25
 )

 [1] = Array
 (
 [id] = 000001
 [_type] = AccountUser
 [username] = Jane Doe
 [email] = janedoe@email.com
 [status] = Active
 [last_login] =
 )
 )
)

Back to the Top

GET ACCOUNTUSER - Get information about a specified user.

https://restapi.surveygizmo.com/v4/accountuser/123456
ParametersExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.debug format):


Array
(
 [result_ok] = 1
 [data] = Array
 (
 [id] = 000002
 [_type] = AccountUser
 [username] = Jane Doe
 [email] = janedoe@email.com
 [status] = Active
 [last_login] = 2012-12-08 15:33:25
 )

)

Back to the Top

CREATE ACCOUNTUSER - Create a new user in your account.

https://restapi.surveygizmo.com/v4/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
create_access_tokentrue (only allowed when using oath)False

Response Example (.debug format):


Array
(
 [result_ok] = 1
 [data] = Array
 (
 [id] = 247926
 [_type] = AccountUser
 [username] = New User
 [email] = newuser@email.com
 [status] =
 [last_login] =
 )

)

Back to the Top

UPDATE ACCOUNTUSER - Update/Change user information.

https://restapi.surveygizmo.com/v4/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

Example Response (.debug format)


Array
(
 [result_ok] = 1
 [data] = Array
 (
 [id] = 179949
 [_type] = AccountUser
 [username] = john2
 [email] = johndoe2@email.com
 [status] = Active
 [last_login] =
 )

)

DELETE ACCOUNTUSER - Delete specified user.

https://restapi.surveygizmo.com/v4/accountuser/123456?_method=DELETE
ParametersValue/ExampleRequired
Authentication Credentialsapi_token=abcd12345&api_token_secret=abcd12345
True

Response Example (.debug format):


Array
(
 [result_ok] = 1
)

Back to the Top