The following API calls are currently available for the AccountTeams object:
GET LIST - Get a list of all of your teams.
https://api.surveygizmo.com/v4/accountteams
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
(
[TeamID] => 389746
[TeamName] => Everyone
[Description] =>
[Color] => #57575A
[DefaultRole] =>
[Status] => Active
)
[1] => Array
(
[TeamID] => 389747
[TeamName] => Team 1
[Description] =>
[Color] => #CC0235
[DefaultRole] =>
[Status] => Active
)
[2] => Array
(
[TeamID] => 453837
[TeamName] => Team 2
[Description] =>
[Color] => #CC0235
[DefaultRole] =>
[Status] => Active
)
)
)
GET ACCOUNTTEAMS - Get information about a specified team.
https://api.surveygizmo.com/v4/accountteams/389747
Parameters | Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
Response Example (.debug format):
Array
(
[result_ok] => 1
[total_count] => 1
[page] => 1
[total_pages] => 1
[results_per_page] => 1
[data] => Array
(
[0] => Array
(
[TeamID] => 389747
[TeamName] => Team 1
[Description] =>
[Color] => #CC0235
[DefaultRole] =>
[Status] => Active
)
)
)
CREATE ACCOUNTTEAM - Create a new team in your account.
https://api.surveygizmo.com/v4/accountteams?_method=PUT&teamname=team3
Parameters | Value/Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
teamname | Team 3 | True |
description | This team will administer marketing surveys | False |
color | #57575A | False |
defaultrole | ID of the role (2-6 for standard roles) | False |
Response Example (.debug format):
Array
(
[result_ok] => 1
[total_count] => 1
[page] => 1
[total_pages] => 1
[results_per_page] => 1
[data] => Array
(
[0] => Array
(
[TeamID] => 498288
[TeamName] => team3
[Description] =>
[Color] => #F36E98
[DefaultRole] =>
[Status] => Active
)
)
)
UPDATE ACCOUNTTEAMS - Update team information.
https://api.surveygizmo.com/v4/accountteam/123456?_method=POST
Parameters | Value/Example | Required |
---|---|---|
Authentication Credentials | api_token=abcd12345&api_token_secret=abcd12345 | True |
teamname | Team 3 | False |
description | This team will administer marketing surveys | False |
color | #57575A | False |
defaultrole | ID of the role (2-6 for standard roles) | False |
Example Response (.debug format)
Array
(
[result_ok] => 1
[total_count] => 1
[page] => 1
[total_pages] => 1
[results_per_page] => 1
[data] => Array
(
[0] => Array
(
[TeamID] => 498288
[TeamName] => Team 5
[Description] =>
[Color] => #F36E98
[DefaultRole] => 5167
[Status] => Active
)
)
)
DELETE ACCOUNTTEAMS - Delete specified team.
https://api.surveygizmo.com/v4/accountteams/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
)