Go to Console
Star on GitHub 45.1K Get started

Teams

SERVER

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.

In admin mode, this endpoint returns a list of all the teams in the current project. Learn more about different API modes.

  • Request
    • search string

      Search term to filter your list results. Max length: 256 chars.

    • limit integer

      Maximum number of teams to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.

    • cursor string

      ID of the team used as the starting point for the query, excluding the team itself. Should be used for efficient pagination when working with large sets of data. learn more about pagination

    • cursorDirection string

      Direction of the cursor, can be either 'before' or 'after'.

    • orderType string

      Order result by ASC or DESC order.

  • Response
Endpoint
GET /teams
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.list()

puts response.inspect

Create Team

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 "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
Endpoint
POST /teams
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.create(team_id: '[TEAM_ID]', name: '[NAME]')

puts response.inspect

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
Endpoint
GET /teams/{teamId}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.get(team_id: '[TEAM_ID]')

puts response.inspect

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
Endpoint
PUT /teams/{teamId}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.update(team_id: '[TEAM_ID]', name: '[NAME]')

puts response.inspect

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}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.delete(team_id: '[TEAM_ID]')

puts response.inspect

Get 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.

    • search string

      Search term to filter your list results. Max length: 256 chars.

    • limit integer

      Maximum number of memberships to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.

    • cursor string

      ID of the membership used as the starting point for the query, excluding the membership itself. Should be used for efficient pagination when working with large sets of data. learn more about pagination

    • cursorDirection string

      Direction of the cursor, can be either 'before' or 'after'.

    • orderType string

      Order result by ASC or DESC order.

  • Response
Endpoint
GET /teams/{teamId}/memberships
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.get_memberships(team_id: '[TEAM_ID]')

puts response.inspect

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
  • 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
Endpoint
POST /teams/{teamId}/memberships
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.create_membership(team_id: '[TEAM_ID]', email: 'email@example.com', roles: [], url: 'https://example.com')

puts response.inspect

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
Endpoint
GET /teams/{teamId}/memberships/{membershipId}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.get_membership(team_id: '[TEAM_ID]', membership_id: '[MEMBERSHIP_ID]')

puts response.inspect

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
Endpoint
PATCH /teams/{teamId}/memberships/{membershipId}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.update_membership_roles(team_id: '[TEAM_ID]', membership_id: '[MEMBERSHIP_ID]', roles: [])

puts response.inspect

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}
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key

teams = Appwrite::Teams.new(client)

response = teams.delete_membership(team_id: '[TEAM_ID]', membership_id: '[MEMBERSHIP_ID]')

puts response.inspect

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
Endpoint
PATCH /teams/{teamId}/memberships/{membershipId}/status
Ruby
require 'appwrite'

client = Appwrite::Client.new

client
    .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
    .set_project('5df5acd0d48c2') # Your project ID
    .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token

teams = Appwrite::Teams.new(client)

response = teams.update_membership_status(team_id: '[TEAM_ID]', membership_id: '[MEMBERSHIP_ID]', user_id: '[USER_ID]', secret: '[SECRET]')

puts response.inspect
Copyright © 2024 Appwrite