AccountUser Object

 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 of your users.

https://restapi.surveygizmo.com/v4/accountuser
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
page page=3 False
resultsperpage resultsperpage=100 False
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
Parameters Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 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
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
create_access_token true (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
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
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
Parameters Value/Example Required
Authentication Credentials api_token=5D685159B6964FB69B044D3E7D2676D1 True
Response Example (.debug format):

Array
(
    [result_ok] = 1
)

Back to the Top