AccountTeams Object v5 | Alchemer REST API

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

GET LIST
GET ACCOUNTTEAMS
CREATE ACCOUNTTEAMS

UPDATE ACCOUNTTEAMS
DELETE ACCOUNTTEAMS

GET LIST - Get a list of all teams in your account.

https://api.alchemer.com/v5/accountteams

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.

Parameters	Example	Required
Authentication Credentials	api_token=abcd12345&api_token_secret=abcd12345	True
showdeleted	true	False

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [total_count] => 3
 [page] => 1
 [total_pages] => 1
 [results_per_page] => 3
 [data] => Array
 (
 [0] => Array
 (
 [id] => 389746
 [team_name] => Everyone
 [description] => 
 [default_role] =>
 [status] => Active
 )

 [1] => Array
 (
 [id] => 389747
 [team_name] => Team 1
 [description] =>
 [default_role] => 
 [status] => Active
 )

 [2] => Array
 (
 [id] => 453837
 [team_name] => Team 2
 [description] =>
 [default_role] => 
 [status] => Active
 )
 )
)

GET ACCOUNTTEAMS - Get information about a specific team in your account.

https://api.alchemer.com/v5/accountteams/389747

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.

Parameters	Example	Required
Authentication Credentials	api_token=abcd12345&api_token_secret=abcd12345	True

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [count] => 1
 [page] => 1
 [results_per_page] => 1
 [data] => Array
 (
 [id] => 235681
 [team_name] => Reporting
 [description] => members have access to reporting only
 [default_role] => 0
 [status] => Active
 )

)

CREATE ACCOUNTTEAM - Create a new team in your account.

https://api.alchemer.com/v5/accountteams?_method=PUT&team_name=team3

Parameters	Value/Example	Required
Authentication Credentials	api_token=abcd12345&api_token_secret=abcd12345	True
team_name	Team 3	True
description	This team will administer marketing surveys	False
default_role	ID of the role (2-6 for standard roles)	False

Response Example (.debug format):


Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 498288
 [team_name] => team3
 [description] =>
 [default_role] => 
 [status] => Active
 )
(

UPDATE ACCOUNTTEAMS - Update team information.

https://api.alchemer.com/v5/accountteams/123456?_method=POST

Parameters	Value/Example	Required
Authentication Credentials	api_token=abcd12345&api_token_secret=abcd12345	True
team_name	Team 3	False
description	This team will administer marketing surveys	False
default_role	ID of the role (2-6 for standard roles)	False

Example Response (.debug format)


Array
(
 [result_ok] => 1
 [data] => Array
 (
 [id] => 498288
 [team_name] => Team 5
 [description] =>
 [default_role] => 5167
 [status] => Active
 )
)

DELETE ACCOUNTTEAMS - Delete specified team.

https://api.alchemer.com/v5/accountteams/123456?_method=DELETE

Parameters	Value/Example	Required
Authentication Credentials	api_token=abcd12345&api_token_secret=abcd12345	True
reassign*	123456 (Team ID)	False

*Use the reassign parameter to assign surveys to another team in your account when deleting a team. If no team is specified as the reassign team, Alchemer will search for an availble team to place the surveys into.

Response Example (.debug format):


Array
(
 [result_ok] = 1
 [data] => Array
 (
 [id] => 236114
 [team_name] => NewTeamName
 [description] => 
 [default_role] => 
 [status] => Deleted
 )
)