The following API calls are currently available for the AccountUser object:
GET LIST - Get a list of all of your users.
https://api.alchemer.com/v4/accountuser
Parameters | Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | 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] =
)
)
)
GET ACCOUNTUSER - Get information about a specified user.
https://api.alchemer.com/v4/accountuser/123456
Parameters | Example | Required |
---|---|---|
Authentication Credentials | api_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
)
)
CREATE ACCOUNTUSER - Create a new user in your account.
https://api.alchemer.com/v4/accountuser?_method=PUT&email=example@example.com
Parameters | Value/Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
john@email.com | True | |
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] =
)
)
UPDATE ACCOUNTUSER - Update/Change user information.
https://api.alchemer.com/v4/accountuser/123456?_method=POST
Parameters | Value/Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
john@email.com | 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://api.alchemer.com/v4/accountuser/123456?_method=DELETE
Parameters | Value/Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
Response Example (.debug format):
Array
(
[result_ok] = 1
)