Skip to main content

Teams

Teams are the organizational boundary for access control. All resources (projects, servers, applications) belong to a team. API tokens are scoped to the team that was active when they were created.

List Teams​

GET /api/v1/teams

Response:

{
"data": [
{
"id": 1,
"name": "My Team",
"description": "Default team",
"created_at": "2024-01-15T10:30:00Z"
}
]
}

Get Current Team​

GET /api/v1/teams/current

Returns the team associated with the API token used in the request.

Get Team by ID​

GET /api/v1/teams/{id}

Response:

{
"id": 1,
"name": "My Team",
"description": "Default team",
"members_count": 5,
"created_at": "2024-01-15T10:30:00Z"
}

List Current Team Members​

GET /api/v1/teams/current/members

Response:

{
"data": [
{
"id": 1,
"name": "Alice",
"email": "[email protected]",
"role": "owner"
},
{
"id": 2,
"name": "Bob",
"email": "[email protected]",
"role": "admin"
},
{
"id": 3,
"name": "Carol",
"email": "[email protected]",
"role": "member"
}
]
}

List Team Members by ID​

GET /api/v1/teams/{id}/members

Team Roles​

RoleDescription
ownerFull access to everything; can manage team settings and billing
adminFull access to all resources; can manage team members
memberAccess based on project/environment permissions
viewerRead-only access when granular permissions are enabled
tip

Team member management (inviting, removing, changing roles) is done through the dashboard UI. The API provides read-only access to team data.