From Bright Pattern Documentation
(Created page with "<translate> = getTeams = Get a list of all available agent teams == Request == === Syntax === {| class="wikitable" |getTeams(): Promise<OperationResult<Team[]>> |} Where: {...") |
(No difference)
|
Revision as of 13:39, 16 September 2022
• 5.19
<translate>
getTeams
Get a list of all available agent teams
Request
Syntax
| getTeams(): Promise<OperationResult<Team[]>> |
Where:
| type Team = {
id: string displayName: string usersCount?: number } |
Parameters
(None)
Example Request
getTeamsButton.onclick = () => {
adApi.getTeams()
}
Return Value
| Object | Object Values | Data Type | Optional?
(Y/N) |
Return Value Description |
| Team | ||||
| id | String | N | The team’s unique ID | |
| displayName | String | N | The team’s display name | |
| usersCount | Number | Y | Displays the number of users in this team |
</translate>