Teams
Teams are organizational units that allow organization owners to group users together, managing team members and access permissions as a whole.
Path and query parameters
Name | Type | Location | Req/Opt | Description |
|---|---|---|---|---|
| integer | path | Required | Organization numeric identifier. |
| integer | query | Optional | Maximum number of results to return. Default: |
| integer | query | Optional | Number of results to skip for pagination. Default: |
| string | query | Optional | Free-text search filter to match against team names. |
| string | query | Optional | The team name to validate for availability and format compliance within the organization. |
| integer | path | Required | Team numeric identifier. |
| integer | path | Required | Member numeric identifier. |
Request body parameters
Name | Type | Req/Opt | Description |
|---|---|---|---|
CreateOrganizationTeam | Create organization team | ||
team | object | Optional | |
team.id | integer | Optional | Team numeric identifier. |
team.name | string | Required | Unique team name within the organization. |
team.description | string | Optional | Optional description of the team. |
team.dateCreated | string | Optional | |
team.lastUpdated | string | Optional | |
avatarId | string | Optional | Avatar image identifier for the team. See Create avatar to upload images and obtain an avatar ID. |
UpdateOrganizationTeam | Update organization team | ||
name | string | Optional | |
description | string | Optional | |
avatarId | string | Optional | Updated avatar image identifier for the team. See Create avatar to upload images and obtain an avatar ID. |
CreateOrganizationTeamMember | Create team member | ||
userNameOrEmail | string | Optional | Username or email address of the organization member to add to the team. |