Team

Delete a team

delete

Authorizations

Path parameters

slugstringRequired

Team slug

Responses

200

Team deleted successfully

application/json

400

Bad request

401

Unauthorized

delete

HTTPcURLJavaScriptPython

DELETE /sfp/api/teams/{slug} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "error": "Team not found"
}

Remove a member from a team

delete

Authorizations

Path parameters

slugstringRequired

Team slug

emailstringRequired

Member email

Responses

200

Member removed successfully

application/json

400

Bad request

401

Unauthorized

403

Forbidden

delete

HTTPcURLJavaScriptPython

DELETE /sfp/api/teams/{slug}/members/{email} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "error": "User not found in team"
}

Update a team member's role

put

Authorizations

Path parameters

slugstringRequired

Team slug

emailstringRequired

Member email

Body

rolestring · enumRequired

The new role for the team member

Possible values:

Responses

200

Member role updated successfully

application/json

400

Bad request

401

Unauthorized

403

Forbidden

put

HTTPcURLJavaScriptPython

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": "[e-mail]",
    "first_name": "Jane",
    "last_name": "Doe",
    "role": "member",
    "created_at": "2025-05-04T07:36:07Z"
  },
  "error": "User not found"
}

Create a new team

post

Authorizations

Body

namestringRequired

The name of the team

Example: Engineering Team

slugstringRequired

The slug for the team URL

Example: engineering-team

descriptionstringOptional

Optional description of the team

Example: Team responsible for product engineering

Responses

201

Team created successfully

application/json

400

Bad request

401

Unauthorized

post

HTTPcURLJavaScriptPython

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": "[e-mail]",
    "created_at": "2025-05-04T07:36:07Z"
  },
  "error": "Team with this slug already exists"
}

List members of a team

get

Authorizations

Path parameters

slugstringRequired

Team slug

Query parameters

limitnumberOptional

Maximum number of members to return

Example: 10

offsetnumberOptional

Offset for pagination

Example: 0

rolestring · enumOptional

Filter by role

Example: ownerPossible values:

Responses

200

List of team members retrieved successfully

application/json

400

Bad request

401

Unauthorized

403

Forbidden

get

HTTPcURLJavaScriptPython

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": "[e-mail]",
      "first_name": "Jane",
      "last_name": "Doe",
      "role": "member",
      "created_at": "2025-05-04T07:36:07Z"
    }
  ],
  "total": 20
}

Add a member to a team

post

Authorizations

Path parameters

slugstringRequired

Team slug

Body

emailstringRequired

Email of the user to add to the team

Example: [e-mail]

rolestring · enumRequired

Role for the user in the team

Example: memberPossible values:

Responses

201

Member added successfully

application/json

400

Bad request

401

Unauthorized

403

Forbidden

post

HTTPcURLJavaScriptPython

POST /sfp/api/teams/{slug}/members HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[e-mail]",
  "role": "member"
}

{
  "success": true,
  "membership": {
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "[e-mail]",
    "first_name": "Jane",
    "last_name": "Doe",
    "role": "member",
    "created_at": "2025-05-04T07:36:07Z"
  },
  "error": "User not found"
}