Team
Permanently deletes a team and all its associations. This action: - Removes all team memberships - Disassociates team from repositories and resources - Removes team-specific permissions and access - Cannot be undone
All team resources must be reassigned or deleted before team deletion. Only users with owner role can delete teams. The last team in an organization cannot be deleted.
Team slug
DELETE /sfp/api/teams/{slug} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"error": "Team not found"
}
Removes a member from a team, revoking their access to team resources. This action: - Removes team membership immediately - Revokes access to all team repositories and resources - Removes team-specific permissions - Does not delete the user account
Team must maintain at least one owner. Users cannot remove themselves if they are the last owner. Only team owners can remove members.
Team slug
Member email
DELETE /sfp/api/teams/{slug}/members/{email} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"success": true,
"error": "User not found in team"
}
Changes the role of an existing team member. Available roles: - owner: Full team management permissions, can add/remove members - member: Access to team resources but no management permissions
Role changes take effect immediately. Teams must maintain at least one owner. Users cannot demote themselves if they are the last owner. Only team owners can change member roles.
Team slug
Member email
The new role for the team member
PUT /sfp/api/teams/{slug}/members/{email}/role HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"role": "owner"
}
{
"success": true,
"membership": {
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"role": "member",
"created_at": "2025-05-04T07:36:07Z"
},
"error": "User not found"
}
Creates a new team within the organization. Teams are used to: - Group users for collaborative access to resources - Manage permissions at a team level - Organize repositories, environments, and other resources
The team slug must be unique and URL-friendly. The creating user automatically becomes a team owner. Only users with owner role can create new teams.
The name of the team
Engineering Team
The slug for the team URL
engineering-team
Optional description of the team
Team responsible for product engineering
POST /sfp/api/teams HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110
{
"name": "Engineering Team",
"slug": "engineering-team",
"description": "Team responsible for product engineering"
}
{
"success": true,
"team": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Engineering Team",
"slug": "engineering-team",
"description": "Team responsible for product engineering",
"primary_owner_user_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"created_at": "2025-05-04T07:36:07Z"
},
"error": "Team with this slug already exists"
}
Retrieves a paginated list of members belonging to a specific team. Returns detailed information about each member including: - User details (ID, email, name) - Role within the team (owner or member) - Join date and last activity
Supports filtering by role and pagination via limit/offset. Users must be members of the team to view its member list. Team membership is verified based on the requesting user's permissions.
Team slug
Maximum number of members to return
10
Offset for pagination
0
Filter by role
owner
Possible values: GET /sfp/api/teams/{slug}/members HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"members": [
{
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"role": "member",
"created_at": "2025-05-04T07:36:07Z"
}
],
"total": 20
}
Adds a new member to an existing team with the specified role. This endpoint: - Creates team membership if user exists in the system - Assigns the specified role (owner or member) - Grants access to team resources based on role - Sends notification to the new member
The user must already have an account in the system. Use the users endpoint to create new users first. Only team owners can add new members.
Team slug
Role for the user in the team
member
Possible values: POST /sfp/api/teams/{slug}/members HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"email": "[email protected]",
"role": "member"
}
{
"success": true,
"membership": {
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"account_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"role": "member",
"created_at": "2025-05-04T07:36:07Z"
},
"error": "User not found"
}
Last updated
Was this helpful?