Teams

SERVER

Platform

Version

The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources, such as database documents or storage files.

Each user who creates a team becomes the team owner and can delegate the ownership role by inviting a new team member. Only team owners can invite new users to their team.

Base URL

https://cloud.appwrite.io/v1

List Teams

Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.

Request
- queries array
  
  Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Teams List

Endpoint

GET /teams

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let teamList = try await teams.list()

    print(String(describing: teamList)
}

Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.

Request
- teamId string
  required
  
  Team ID. Choose your own unique ID or pass the string ID.unique() to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
- name string
  required
  
  Team name. Max length: 128 chars.
- roles array
  
  Array of strings. Use this param to set the roles in the team for the user who created it. The default role is owner. A role can be any string. Learn more about roles and permissions. Maximum of 100 roles are allowed, each 32 characters long.
Response
- 201 application/json
  
  Team

Endpoint

POST /teams

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let team = try await teams.create(
        teamId: "[TEAM_ID]",
        name: "[NAME]"
    )

    print(String(describing: team)
}

Get Team

Get a team by its ID. All team members have read access for this resource.

Request
- teamId string
  required
  
  Team ID.
Response
- 200 application/json
  
  Team

Endpoint

GET /teams/{teamId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let team = try await teams.get(
        teamId: "[TEAM_ID]"
    )

    print(String(describing: team)
}

Update Team

Update a team using its ID. Only members with the owner role can update the team.

Request
- teamId string
  required
  
  Team ID.
- name string
  required
  
  New team name. Max length: 128 chars.
Response
- 200 application/json
  
  Team

Endpoint

PUT /teams/{teamId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let team = try await teams.update(
        teamId: "[TEAM_ID]",
        name: "[NAME]"
    )

    print(String(describing: team)
}

Delete Team

Delete a team using its ID. Only team members with the owner role can delete the team.

Request
- teamId string
  required
  
  Team ID.
Response
- 204 application/json

Endpoint

DELETE /teams/{teamId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let result = try await teams.delete(
        teamId: "[TEAM_ID]"
    )

    print(String(describing: result)
}

List Team Memberships

Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.

Request
- teamId string
  required
  
  Team ID.
- queries array
  
  Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm
- search string
  
  Search term to filter your list results. Max length: 256 chars.
Response
- 200 application/json
  
  Memberships List

Endpoint

GET /teams/{teamId}/memberships

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let membershipList = try await teams.listMemberships(
        teamId: "[TEAM_ID]"
    )

    print(String(describing: membershipList)
}

Create Team Membership

Invite a new member to join your team. If initiated from the client SDK, an email with a link to join the team will be sent to the member's email address and an account will be created for them should they not be signed up already. If initiated from server-side SDKs, the new member will automatically be added to the team.

Use the 'url' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the Update Team Membership Status endpoint to allow the user to accept the invitation to the team.

Please note that to avoid a Redirect Attack the only valid redirect URL's are the once from domains you have set when adding your platforms in the console interface.

Request
- teamId string
  required
  
  Team ID.
- email string
  required
  
  Email of the new team member.
- roles array
  required
  
  Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about roles and permissions. Maximum of 100 roles are allowed, each 32 characters long.
- url string
  required
  
  URL to redirect the user back to your app from the invitation email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an open redirect attack against your project API.
- name string
  
  Name of the new team member. Max length: 128 chars.
Response
- 201 application/json
  
  Membership
Rate limits

This endpoint is not limited when using Server SDKs with API keys. If you are using SSR with setSession, these rate limits will still apply. Learn more about SSR rate limits.

The limit is applied for each unique limit key.

Time frame

Attempts

Key

60 minutes 10 requests URL + IP

Learn more about rate limits

Time frame	Attempts	Key
60 minutes	10 requests	URL + IP

Endpoint

POST /teams/{teamId}/memberships

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let membership = try await teams.createMembership(
        teamId: "[TEAM_ID]",
        email: "email@example.com",
        roles: [],
        url: "https://example.com"
    )

    print(String(describing: membership)
}

Get Team Membership

Get a team member by the membership unique id. All team members have read access for this resource.

Request
- teamId string
  required
  
  Team ID.
- membershipId string
  required
  
  Membership ID.
Response
- 200 application/json
  
  Membership

Endpoint

GET /teams/{teamId}/memberships/{membershipId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let membership = try await teams.getMembership(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]"
    )

    print(String(describing: membership)
}

Update Membership Roles

Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about roles and permissions.

Request
- teamId string
  required
  
  Team ID.
- membershipId string
  required
  
  Membership ID.
- roles array
  required
  
  An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about roles and permissions. Maximum of 100 roles are allowed, each 32 characters long.
Response
- 200 application/json
  
  Membership

Endpoint

PATCH /teams/{teamId}/memberships/{membershipId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let membership = try await teams.updateMembershipRoles(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]",
        roles: []
    )

    print(String(describing: membership)
}

Delete Team Membership

This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.

Request
- teamId string
  required
  
  Team ID.
- membershipId string
  required
  
  Membership ID.
Response
- 204 application/json

Endpoint

DELETE /teams/{teamId}/memberships/{membershipId}

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setKey("919c2d18fb5d4...a2ae413da83346ad2") // Your secret API key
    let teams = Teams(client)
    let result = try await teams.deleteMembership(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]"
    )

    print(String(describing: result)
}

Update Team Membership Status

Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.

If the request is successful, a session for the user is automatically created.

Request
- teamId string
  required
  
  Team ID.
- membershipId string
  required
  
  Membership ID.
- userId string
  required
  
  User ID.
- secret string
  required
  
  Secret key.
Response
- 200 application/json
  
  Membership

Endpoint

PATCH /teams/{teamId}/memberships/{membershipId}/status

Swift

import Appwrite

func main() async throws {
    let client = Client()
      .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint
      .setProject("5df5acd0d48c2") // Your project ID
      .setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...") // Your secret JSON Web Token
    let teams = Teams(client)
    let membership = try await teams.updateMembershipStatus(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]",
        userId: "[USER_ID]",
        secret: "[SECRET]"
    )

    print(String(describing: membership)
}

Recommended