Teams API allows creating and editing Teams.
AUTHENTICATION
A suite user token obtained via the login API must be provided in the request headers as a bearer token.
Authorization: Bearer <user-token>
Provides a way to get a list of teams of a Suite Organization.
Name | Type | Requirement | Description |
action | String | Mandatory | getTeams |
organizationId | Number | Mandatory | Suite Organization ID |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=getTeams&organizationId=1909009curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?organizationId\=1909009\&action\=getTeams
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{ {
"id": 4039601,
"description": "",
"name": "Icareus Testers"
},
{
"id": 4035101,
"description": "",
"name": "Kitchen sink"
},
{
"id": 4037001,
"description": "",
"name": "The last one"
}
],
"status": "ok"
}
|
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"
Name | Type | Requirement | Description |
action | String | Mandatory | getTeam |
organizationId | Number | Mandatory | Suite Organization ID |
teamId | Number | Mandatory | ID of the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=getTeam&organizationId=1909009&teamId=4039601curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?action\=getTeam\&organizationId\=1909009\&teamId\=4039601
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{
"status": "ok",
"team": {
"id": 4039601,
"users": [
{
"lastName": "Kuikka",
"userId": 3992501,
"ismRole": "",
"screenName": "mievaan",
"emailAddress": "pasi@a.com",
"firstName": "Pasi"
}, { "lastName": "Smith",
"userId": 3999901,
"ismRole": "Account User",
"screenName": "blaa",
"emailAddress": "john@a.com",
"firstName": "John"
} ], "description": "",
"name": "Icareus Testers"
}
} |
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"
Provides a way to create a team.
Name | Type | Requirement | Description |
action | String | Mandatory | createTeam |
organizationId | Number | Mandatory | Suite Organization ID |
name | String | Mandatory | Name of the Team |
description | String | Optional | Description of the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=createTeam&organizationId=1909009&name=team%20api%20test%20%edited&description=descriptioncurl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET https\://suiterc.icareus.com/api/teams\?action\=createTeam\&organizationId\=1909009\&name\=team\%20api\%20test\%20edited\&description\=description |
{
"message": "team created",
"status": "ok",
"team": {
"id": 9576301,
"users": [],
"description": "description",
"name": "test team"
}
}
|
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"
DELETE TEAM
Name | Type | Requirement | Description |
action | String | Mandatory | deleteTeam |
organizationId | Number | Mandatory | Suite ORganization ID |
teamId | Number | Mandatory | ID of the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=deleteTeam&organizationId=1909009&teamId=9536101curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?action\=deleteTeam\&organizationId\=1909009\&teamId\=9536101
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{ "message": "team deleted", "status": "ok" } |
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"
Provides a way to edit a team of a Suite Organization based on the teamId.
Name | Type | Requirement | Description |
action | String | Mandatory | editTeam |
organizationId | Number | Mandatory | editTeam |
| teamId | Number | Mandatory | ID of the Team |
name | String | Optional | New name for the Team |
description | String | Optional | New description for the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=editTeam&organizationId=1909009&name=edited%20team&description=edited%20team%20description&teamId=9576301curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?action\=editTeam\&organizationId\=1909009\&name\=edited\%20team\%20description\&teamId\=9576301
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{
"message": "team updated",
"status": "ok",
"team": {
"id": 9576301,
"users": [],
"description": "edited team description",
"name": "edited team"
}
}
|
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error"
as well as "message": "what-went-wrong"
Returns a list of available users that can be added to the provided team.
Name | Type | Requirement | Desciption |
action | String | Mandatory | getAvailableUsers |
organizationId | Number | Mandatory | Suite Organization ID |
teamId | Number | Mandatory | ID of the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=getAvailableUsers&organizationId=1909009&teamId=9576301curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?action\=getAvailableUsers\&organizationId\=1909009\&teamId\=9576301
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{
"message": "success",
"users": [
{
"lastName": "User1",
"userId": 6076801,
"ismRole": "Account User",
"screenName": "testaccountuser",
"emailAddress": "testaccountuser1@icareus.com",
"firstName": "Test"
},
{
"lastName": "X",
"userId": 6746401,
"ismRole": "IsmSubscriber",
"screenName": "pjotrix",
"emailAddress": "pjotrix@hotmailx.com",
"firstName": "pjotri"
},
{
"lastName": "User",
"userId": 8453202,
"ismRole": "Account Admin",
"screenName": "testtestuser",
"emailAddress": "test.user@icareus.com",
"firstName": "Test"
}
],
"status": "ok"
}
|
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error"
as well as "message": "what-went-wrong"
Provides a way to add a given Suite user to the provided Team.
Path: /api/teams
Method: GET
Dame | Type | Requirement | Description |
action | String | Mandatory | getAvailableUsers |
organizationId | Number | Mandatory | Suite Organization ID |
teamId | Number | Mandatory | ID of the Team |
userId | Number | Mandatory | ID of the user to be added to the Team |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=addTeamUser&organizationId=1909009&teamId=9576301&userId=4035901
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{
"message": "user added to team",
"status": "ok",
"team": {
"id": 9576301,
"users": [
{
"lastName": "Admin",
"userId": 4035901,
"ismRole": "Account Admin",
"screenName": "ossiadmin",
"emailAddress": "ossiadmin@icareus.com",
"firstName": "Ossi"
}
],
"description": "edited team description",
"name": "edited team"
}
} |
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"
Provides a way to add a given Suite user to the provided Team.
Name | Type | Requirement | Description |
action | String | Mandatory | getAvailableUsers |
organizationId | Number | Mandatory | Suite Organization ID |
teamId | Number | Mandatory | ID of the Team |
userId | Number | Mandatory | ID of the user to be removed |
This is just an example meant to demonstrate what a correct call and response might look like, the request might not actually work if ran.
https://suiterc.icareus.com/api/teams?action=removeTeamUser&organizationId=1909009&teamId=9576301&userId=4035901
curl -i -H Authorization\:\ Bearer\ user_token -H Content-Type\:\ application/json -XGET
https\://suiterc.icareus.com/api/teams\?action\=removeTeamUser\&organizationId\=1909009\&teamId\=9576301\&userId\=4035901
|
A successful response will have the HTTP Status code 200 and the JSON response will contain "status": "ok".
{
"status": "ok",
"team": {
"id": 9576301,
"users": [],
"description": "edited team description",
"name": "edited team"
}
}
|
An error response will have a non-200 HTTP Status code and the JSON response will contain "status": "error" as well as "message": "what-went-wrong"