Skip to main content

Teams API

Get one team

GET /team/id (Get one team)
Headers
nametypedata typedescription
AuthorizationrequiredstringBearer token
Parameters
nametypedata typedescription
idrequiredstringTeam ID
Responses
http codecontent-typeresponse
200application/json{ err: false, data: Team details }
403application/jsonNo project permission access
404application/jsonTeam Not found
Example
 GET /team/614aa2a260318c20a6fed424

Get team list for one project

GET /team (Get team list for specific project)
Headers
nametypedata typedescription
AuthorizationrequiredstringBearer token
Query String
nametypedata typedescription
projectrequiredstringProject ID
Responses
http codecontent-typeresponse
200application/json{ err: false, data: Array of teams }
403application/jsonNo project permission access
Example
 GET /team?project=614aa2a260318c20a6fed424

Create one team

POST /team (Create one team)
Headers
nametypedata typedescription
AuthorizationrequiredstringBearer token
Body
nametypedata typedescription
namerequiredstringTeam Name (Unique)
projectrequiredstringProject ID
ownerrequiredstringTeam leader User ID
membersoptionalstringArray of User ID
Responses
http codecontent-typeresponse
200application/json{ err: false, data: Team detail }
403application/jsonNo permission access
Example
 POST /team
{
name: 'Developers',
project: 'project-id',
owner: 'unique-user-id',
members: ['user-id-1','user-id-2']
}

Update team

PUT /team/id (Update team)
Headers
nametypedata typedescription
AuthorizationrequiredstringBearer token
Parameters
nametypedata typedescription
idrequiredstringTeam ID
Body
nametypedata typedescription
namerequiredstringTeam Name (Unique)
ownerrequiredstringTeam leader User ID
membersoptionalstringArray of User ID
addUseroptionalstringArray of user IDs to be inserted.
removeUseroptionalstringArray of user IDs to be removed.
Responses
http codecontent-typeresponse
200application/json{ err: false, data: Team details }
403application/jsonNo permission access
404application/jsonTeam Not found
Example
 PUT /team/unique-team-id
{
name: 'Developers',
addUser: ['insert-user-id-1','insert-user-id-2']
}

Delete team

DELETE /team/id (Delete team)
Headers
nametypedata typedescription
AuthorizationrequiredstringBearer token
Parameters
nametypedata typedescription
idrequiredstringTeam ID
Responses
http codecontent-typeresponse
200application/json
403application/jsonNo permission access
404application/jsonTeam Not found
Example
 DELETE /team/team-unique-id