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.
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 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, billingPlan
search Search term to filter your list results. Max length: 256 chars.
Response
200
GET /teams
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.list(
[], // queries (optional)
'<SEARCH>' // search (optional)
);
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 requiredTeam ID. Choose a custom ID or generate a random ID with
ID.unique()
. 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 requiredTeam name. Max length: 128 chars.
roles 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
POST /teams
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.create(
'<TEAM_ID>', // teamId
'<NAME>', // name
[] // roles (optional)
);
Get team
Get a team by its ID. All team members have read access for this resource.
Request
teamId requiredTeam ID.
Response
200
GET /teams/{teamId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.get(
'<TEAM_ID>' // teamId
);
Update name
Update the team's name by its unique ID.
Request
teamId requiredTeam ID.
name requiredNew team name. Max length: 128 chars.
Response
200
PUT /teams/{teamId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.updateName(
'<TEAM_ID>', // teamId
'<NAME>' // name
);
Delete team
Delete a team using its ID. Only team members with the owner role can delete the team.
Request
teamId requiredTeam ID.
Response
204
DELETE /teams/{teamId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.delete(
'<TEAM_ID>' // teamId
);
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 requiredTeam ID.
queries 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 Search term to filter your list results. Max length: 256 chars.
Response
200
GET /teams/{teamId}/memberships
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.listMemberships(
'<TEAM_ID>', // teamId
[], // queries (optional)
'<SEARCH>' // search (optional)
);
Create team membership
Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.
You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
Use the url
parameter to redirect the user from the invitation email to your app. After 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 Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.
Request
teamId requiredTeam ID.
roles requiredArray 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.
email Email of the new team member.
userId ID of the user to be added to a team.
phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
url URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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 Name of the new team member. Max length: 128 chars.
Response
201
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 frameAttemptsKey60 minutes 10 requests URL + IP
POST /teams/{teamId}/memberships
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.createMembership(
'<TEAM_ID>', // teamId
[], // roles
'[email protected]', // email (optional)
'<USER_ID>', // userId (optional)
'+12065550100', // phone (optional)
'https://example.com', // url (optional)
'<NAME>' // name (optional)
);
Get team membership
Get a team member by the membership unique id. All team members have read access for this resource.
Request
teamId requiredTeam ID.
membershipId requiredMembership ID.
Response
200
GET /teams/{teamId}/memberships/{membershipId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.getMembership(
'<TEAM_ID>', // teamId
'<MEMBERSHIP_ID>' // membershipId
);
Update membership
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 requiredTeam ID.
membershipId requiredMembership ID.
roles requiredAn 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
PATCH /teams/{teamId}/memberships/{membershipId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.updateMembership(
'<TEAM_ID>', // teamId
'<MEMBERSHIP_ID>', // membershipId
[] // roles
);
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 requiredTeam ID.
membershipId requiredMembership ID.
Response
204
DELETE /teams/{teamId}/memberships/{membershipId}
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.deleteMembership(
'<TEAM_ID>', // teamId
'<MEMBERSHIP_ID>' // membershipId
);
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 requiredTeam ID.
membershipId requiredMembership ID.
userId requiredUser ID.
secret requiredSecret key.
Response
200
PATCH /teams/{teamId}/memberships/{membershipId}/status
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.updateMembershipStatus(
'<TEAM_ID>', // teamId
'<MEMBERSHIP_ID>', // membershipId
'<USER_ID>', // userId
'<SECRET>' // secret
);
Get team preferences
Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in user preferences.
Request
teamId requiredTeam ID.
Response
200
GET /teams/{teamId}/prefs
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.getPrefs(
'<TEAM_ID>' // teamId
);
Update preferences
Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
Request
teamId requiredTeam ID.
prefs requiredPrefs key-value JSON object.
Response
200
PUT /teams/{teamId}/prefs
const sdk = require('node-appwrite');
const client = new sdk.Client()
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>') // Your project ID
.setSession(''); // The user session to authenticate with
const teams = new sdk.Teams(client);
const result = await teams.updatePrefs(
'<TEAM_ID>', // teamId
{} // prefs
);