Vikunja.API.Team

Operations

Team

teamsGet

teamsGet :: VikunjaRequest TeamsGet MimeNoContent [ModelsTeam] MimeJSON

GET /teams

Get teams

Returns all teams the current user is part of.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsGet

Instances

Produces TeamsGet MimeJSON

application/json

Defined in Vikunja.API.Team

HasOptionalParam TeamsGet S

Optional Param "s" - Search teams by its name.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> S -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> S -> VikunjaRequest TeamsGet contentType res accept

HasOptionalParam TeamsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> PerPage -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> PerPage -> VikunjaRequest TeamsGet contentType res accept

HasOptionalParam TeamsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> Page -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> Page -> VikunjaRequest TeamsGet contentType res accept

teamsIdDelete

teamsIdDelete

Arguments

:: Id

"id" - Team ID

-> VikunjaRequest TeamsIdDelete MimeNoContent ModelsMessage MimeJSON

DELETE /teams/{id}

Deletes a team

Delets a team. This will also remove the access for all users in that team.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdDelete

Instances

Produces TeamsIdDelete MimeJSON

application/json

Defined in Vikunja.API.Team

teamsIdGet

teamsIdGet

Arguments

:: Id

"id" - Team ID

-> VikunjaRequest TeamsIdGet MimeNoContent ModelsTeam MimeJSON

GET /teams/{id}

Gets one team

Returns a team by its ID.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdGet

Instances

Produces TeamsIdGet MimeJSON

application/json

Defined in Vikunja.API.Team

teamsIdMembersPut

teamsIdMembersPut

Arguments

:: (Consumes TeamsIdMembersPut MimeJSON, MimeRender MimeJSON ModelsTeamMember)

=> ModelsTeamMember

"team" - The user to be added to a team.

-> Id

"id" - Team ID

-> VikunjaRequest TeamsIdMembersPut MimeJSON ModelsTeamMember MimeJSON

PUT /teams/{id}/members

Add a user to a team

Add a user to a team.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdMembersPut

Instances

Produces TeamsIdMembersPut MimeJSON

application/json

Defined in Vikunja.API.Team

Consumes TeamsIdMembersPut MimeJSON

application/json

Defined in Vikunja.API.Team

HasBodyParam TeamsIdMembersPut ModelsTeamMember

Body Param "team" - The user to be added to a team.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsIdMembersPut contentType, MimeRender contentType ModelsTeamMember) => VikunjaRequest TeamsIdMembersPut contentType res accept -> ModelsTeamMember -> VikunjaRequest TeamsIdMembersPut contentType res accept

teamsIdMembersUserIDAdminPost

teamsIdMembersUserIDAdminPost

Arguments

:: Id

"id" - Team ID

-> UserId

"userId" - User ID

-> VikunjaRequest TeamsIdMembersUserIDAdminPost MimeNoContent ModelsMessage MimeJSON

POST /teams/{id}/members/{userID}/admin

Toggle a team member's admin status

If a user is team admin, this will make them member and vise-versa.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdMembersUserIDAdminPost

Instances

Produces TeamsIdMembersUserIDAdminPost MimeJSON

application/json

Defined in Vikunja.API.Team

teamsIdMembersUserIDDelete

teamsIdMembersUserIDDelete

Arguments

:: Id

"id" - Team ID

-> UserId

"userId" - User ID

-> VikunjaRequest TeamsIdMembersUserIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /teams/{id}/members/{userID}

Remove a user from a team

Remove a user from a team. This will also revoke any access this user might have via that team. A user can remove themselves from the team if they are not the last user in the team.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdMembersUserIDDelete

Instances

Produces TeamsIdMembersUserIDDelete MimeJSON

application/json

Defined in Vikunja.API.Team

teamsIdPost

teamsIdPost

Arguments

:: (Consumes TeamsIdPost MimeJSON, MimeRender MimeJSON ModelsTeam)

=> ModelsTeam

"team" - The team with updated values you want to update.

-> Id

"id" - Team ID

-> VikunjaRequest TeamsIdPost MimeJSON ModelsTeam MimeJSON

POST /teams/{id}

Updates a team

Updates a team.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsIdPost

Instances

Produces TeamsIdPost MimeJSON

application/json

Defined in Vikunja.API.Team

Consumes TeamsIdPost MimeJSON

application/json

Defined in Vikunja.API.Team

HasBodyParam TeamsIdPost ModelsTeam

Body Param "team" - The team with updated values you want to update.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsIdPost contentType, MimeRender contentType ModelsTeam) => VikunjaRequest TeamsIdPost contentType res accept -> ModelsTeam -> VikunjaRequest TeamsIdPost contentType res accept

teamsPut

teamsPut

Arguments

:: (Consumes TeamsPut MimeJSON, MimeRender MimeJSON ModelsTeam)

=> ModelsTeam

"team" - The team you want to create.

-> VikunjaRequest TeamsPut MimeJSON ModelsTeam MimeJSON

PUT /teams

Creates a new team

Creates a new team.

AuthMethod: AuthApiKeyJWTKeyAuth

data TeamsPut

Instances

Produces TeamsPut MimeJSON

application/json

Defined in Vikunja.API.Team

Consumes TeamsPut MimeJSON

application/json

Defined in Vikunja.API.Team

HasBodyParam TeamsPut ModelsTeam

Body Param "team" - The team you want to create.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsPut contentType, MimeRender contentType ModelsTeam) => VikunjaRequest TeamsPut contentType res accept -> ModelsTeam -> VikunjaRequest TeamsPut contentType res accept