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.
Quick Reference
/api/teams
200 OK
Get All Teams
Retrieves a paginated list of all teams in the system. Use the pageNumber
and pageSize query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
pageNumber |
integer | 1 |
Page number, 1-based index. Values below 1 are treated as 1. |
pageSize |
integer | 10 |
Number of records per page, from 1 to 100. Values outside this range are clamped. |
/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.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique team identifier |
/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.
/api/teams
201 Created
Create Team
Creates a new team in an existing department. On success, returns 201 Created with the new team. Returns 400 Bad Request if the department does not exist.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
departmentId |
integer | Required | Department id |
/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. If the team moves to another department, its members stay in their own department and are removed from the team.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
departmentId |
integer | Required | Department id |
/api/teams/{id}
204 No Content
Delete Team
Permanently removes a team by its ID. Employees in the team are not deleted; they stay in their department without a team. This action cannot be undone.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the team to delete |