Teams API
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.
Create Team
Create a new team. The user who creates the team will automatically be assigned as the owner of the team. The team owner can invite new members, who will be able add new owners and update or delete the team from your project.
Request
Name | Type | Description | |
name | required | string | Team name. |
roles | optional | 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. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.create('[NAME]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.create( name: '[NAME]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
List Teams
Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project teams. Learn more about different API modes.
Request
Name | Type | Description | |
search | optional | string | Search term to filter your list results. |
limit | optional | integer | Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request. |
offset | optional | integer | Results offset. The default value is 0. Use this param to manage pagination. |
orderType | optional | string | Order result by ASC or DESC order. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.list(); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.list( ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Get Team
Get team by its unique ID. All team members have read access for this resource.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.get('[TEAM_ID]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.get( teamId: '[TEAM_ID]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Update Team
Update team by its unique ID. Only team owners have write access for this resource.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
name | required | string | Team name. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.update('[TEAM_ID]', '[NAME]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.update( teamId: '[TEAM_ID]', name: '[NAME]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Delete Team
Delete team by its unique ID. Only team owners have write access for this resource.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.delete('[TEAM_ID]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.delete( teamId: '[TEAM_ID]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Create Team Membership
Use this endpoint to invite a new member to join your team. An email with a link to join the team will be sent to the new member email address if the member doesn't exist in the project it will be created automatically.
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 in order to avoid a Redirect Attacks the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
required | string | New team member email. | |
roles | required | array | 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. |
url | required | string | 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 | optional | string | New team member name. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.createMembership('[TEAM_ID]', 'email@example.com', [], 'https://example.com'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.createMembership( teamId: '[TEAM_ID]', email: 'email@example.com', roles: [], url: 'https://example.com', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Get Team Memberships
Get team members by the team unique ID. All team members have read access for this list of resources.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
search | optional | string | Search term to filter your list results. |
limit | optional | integer | Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request. |
offset | optional | integer | Results offset. The default value is 0. Use this param to manage pagination. |
orderType | optional | string | Order result by ASC or DESC order. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.getMemberships('[TEAM_ID]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.getMemberships( teamId: '[TEAM_ID]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
Update Team Membership Status
Use this endpoint to allow a user to accept an invitation to join a team after he is being redirected back to your app from the invitation email he was sent.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
inviteId | required | string | Invite unique ID. |
userId | required | string | User unique ID. |
secret | required | string | Secret key. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.updateMembershipStatus('[TEAM_ID]', '[INVITE_ID]', '[USER_ID]', '[SECRET]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.updateMembershipStatus( teamId: '[TEAM_ID]', inviteId: '[INVITE_ID]', userId: '[USER_ID]', secret: '[SECRET]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }
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 he didn't accept it.
Request
Name | Type | Description | |
teamId | required | string | Team unique ID. |
inviteId | required | string | Invite unique ID. |
-
let sdk = new Appwrite(); sdk .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; let promise = sdk.teams.deleteMembership('[TEAM_ID]', '[INVITE_ID]'); promise.then(function (response) { console.log(response); // Success }, function (error) { console.log(error); // Failure });
-
import 'package:appwrite/appwrite.dart'; void main() { // Init SDK Client client = Client(); Teams teams = Teams(client); client .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint .setProject('5df5acd0d48c2') // Your project ID ; Future result = teams.deleteMembership( teamId: '[TEAM_ID]', inviteId: '[INVITE_ID]', ); result .then((response) { print(response); }).catchError((error) { print(error.response); }); }