Skip to main content

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

orgId

integer

path

Required

Organization numeric identifier

max

integer

query

Optional

Pagination result max result

offset

integer

query

Optional

Pagination offset

search

string

query

Optional

Filter search parameter

name

string

query

Optional

Organization name to validate

teamId

integer

path

Required

Team numeric identifier

memberId

integer

path

Required

Member numeric identifier

Request body parameters

Name

Type

Req/Opt

Description

CreateOrganizationTeam

Create team

team

object

Optional

team.id

integer

Optional

team.name

string

Required

team.description

string

Optional

team.dateCreated

string

Optional

team.lastUpdated

string

Optional

avatarId

string

Optional

UpdateOrganizationTeam

Update team

name

string

Optional

description

string

Optional

avatarId

string

Optional

CreateOrganizationTeamMember

Create team member

userNameOrEmail

string

Optional