Team

get

/team/:teamid/profile (authenticated)

Get a single team profile with details, if member_of.

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. member_of
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/profile/public

Get a single team profile, if public.

Accepted Restful Arguments

numberteamid: the team ID
get

/teams (authenticated)

Get a list of all the teams the user has access to

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Accepted Query Arguments

integer page: The desired page
integer pageSize: The desired page size
post

/team (authenticated)

Creates a new team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Accepted Body Arguments

{
// the team name
name: string,
// whether or not the team is private
private: boolean,
// the plan to use for the team
team: integer,
}
delete

/team/:teamid (authenticated)

Deletes a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. team_management
Accepted Restful Arguments

teamid: The id of the team to act on
post

/team/:teamid (authenticated)

Updates a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. team_management
Accepted Body Arguments

{
// the team name
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
post

/team/:teamid/user/:userid (authenticated)

Assign a user to a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. team_management
Accepted Restful Arguments

teamid: The id of the team to act on
userid: undocumented
delete

/team/:teamid/user/batch (authenticated)

Removes a batch of users from a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. team_management
Accepted Body Arguments

{
// Comma separated list of user ids
users: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
delete

/team/:teamid/user/:userid (authenticated)

Removes a user from a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. team_management
Accepted Restful Arguments

teamid: The id of the team to act on
userid: undocumented
get

/division/:divisionid/users (authenticated)

Get a list of all users in a given division

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. member_of
Accepted Restful Arguments

divisionid: undocumented
get

/team/:teamid/users (authenticated)

Get a list of all users in a given team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. member_of
Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/fonts

Get a list of all fonts in a given team

Accepted Restful Arguments

teamid: The id of the team to act on
get

/team/:teamid/logos

Get a list of all logos in a given team

Accepted Restful Arguments

teamid: The id of the team to act on
post

/team/:teamid/logo (authenticated)

Add a new logo to a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Accepted Body Arguments

{
// the logo file
file: file,
// the logo name
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
post

/team/:teamid/font (authenticated)

Add a new font to a team

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Accepted Body Arguments

{
// the font file
file: file,
// the font name
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
post

/team/:teamid/font/:fontid (authenticated)

Update font

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Accepted Body Arguments

{
// the font file
file: file,
// the font name
name: string,
}
Accepted Restful Arguments

teamid: The id of the team to act on
fontid: undocumented
post

/team/:teamid/delete/logo/:logoid (authenticated)

Delete logo

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. customise_editor
Accepted Restful Arguments

teamid: The id of the team to act on
logoid: undocumented
post

/team/:teamid/delete/font/:fontid (authenticated)

Delete font

Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.

Required Team Permissions

  1. customise_editor
Accepted Restful Arguments

teamid: The id of the team to act on
fontid: undocumented
Did you find what you were looking for? Thank you! There was a problem submitting your feedback. Please try again later.