Teams API

v1.0 • REST • JSON

Full CRUD management for team accounts. Create, retrieve, update, and delete team records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/teams

Quick Reference

GET
/api/teams List all teams (paginated)
200 GET
/api/teams/{id} Get one team by ID
200 POST
/api/teams Create a new team
201 PUT
/api/teams/{id} Replace team data
204 DEL
/api/teams/{id} Remove a team
204 GET
/api/teams/{id} Team not found example
404
GET /api/teams 200 OK

Get All Teams

Retrieves a paginated list of all teams in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/teams/{id} 200 OK

Get Single Team

Fetch the full profile for a specific team using their numeric ID. Returns all team fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique team identifier
Response: 200 OK
GET /api/teams/{id} 404 Not Found

Team Not Found

Returned when the requested team ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing team resources.

Response: 404 Not Found
POST /api/teams 201 Created

Create Team

Registers a new team with the provided details. On success, returns the newly created team object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
organisationId integer Required Organisation id
organisation string Optional Organisation
Body
Response: 201 Created
PUT /api/teams/{id} 200 OK

Update Team

Fully replaces an existing team's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
organisationId integer Required Organisation id
organisation string Optional Organisation
Body
Response: 200 OK
DELETE /api/teams/{id} 204 No Content

Delete Team

Permanently removes a team from the system by their ID. This action is irreversible once deleted, the team record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the team to delete
Response: 204 No Content