Teams- Get a list of teams or Create, Edit, and Delete teams

The following requests relate to creating, updating and getting teams via the Litmos Training Engine API.

Note: All requests must be Authenticated.

Get Team List

Returns a list of teams in your organisation. By default only the first 100 people are returned. The list can be filtered on first or last name and paged using the optional paging parameters.

AccessLevel: Trainers Only

Request Uri

GET /teams

or for sub teams 

GET /teams/{teamId}/teams

Response

<Teams> 
   <Team> 
   <Id>string [max length 50]</Id> 
   <Name>string [max length 100]</Name> 
   </Team> 
</Teams>

Get Team

Returns a single team for the given team Id.

AccessLevel: Trainers Only

Request Uri

GET /teams/{team-id}

Response

Returns HTTP status code 200 on success and the team in the response body

<Team> 
   <Id>string [max length 50]</Id>  
   <Name>string [max length 100]</Name> 
   <Description>string [optional, max length 1000]</Description> 
</Team>

Create Team or Sub-Team

Creates a new team or sub team in your organisation.

AccessLevel: Trainers Only

Request Uri

POST /teams
or to create a sub team 
POST /teams/{teamId}/teams

Request Body

<Team> 
   <Id></Id>   
   <Name>string [max length 100]</Name>  
   <Description>string [optional, max length 1000]</Description>  
</Team>

Response

Returns a HTTP status code 201 (Created) on success with the new team Id populated in the response body.

<Team> 
   <Id>string [max length 50]</Id>  
   <Name>string [max length 100]</Name>  
   <Description>string [optional, max length 1000]</Description>  
</Team>

Update Team

Update a single team profile in your organisation.  The team Id in the Uri must match the Id specified in the request body.

AccessLevel: Trainers Only

PUT /teams/{team-id}

Request Body

<Team> 
   <Id>string [max length 50]</Id>    
   <Name>string [max length 100]</Name>  
   <Description>string [optional, max length 1000]</Description>  
</Team>

Response

Returns a HTTP status code 200 on success

Delete Team

Delete a single team profile in your organisation.  The team Id in the Uri must match the Id specified in the request body.

AccessLevel: Trainers Only

DELETE /teams/{team-id}

Response

Returns a HTTP status code 200 on success

Have more questions? Submit a request

0 Comments

Article is closed for comments.