Docs

Teams API


Client integration with  

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

POST/v1/teams

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.

HTTP Request

Name Type Description
teamId required string

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 required string

Team name. Max length: 128 chars.

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. Maximum of 100 roles are allowed, each 32 characters long.

HTTP Response

Status Code Content Type Payload
201  Created application/json Team Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.create('[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.create(
        teamId: '[TEAM_ID]',
        name: '[NAME]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let team = try await teams.create(
        teamId: "[TEAM_ID]",
        name: "[NAME]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.create(
        teamId = "[TEAM_ID]",
        name = "[NAME]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.create(
        "[TEAM_ID]",
        "[NAME]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsCreate(
            teamId: "[TEAM_ID]",
            name: "[NAME]"
        ) {
            _id
            _createdAt
            _updatedAt
            name
            total
        }
    }
    
  • POST /v1/teams HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "teamId": "[TEAM_ID]",
      "name": "[NAME]",
      "roles": []
    }
    

List Teams

GET/v1/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.

HTTP Request

Name Type Description
queries optional 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 optional string

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

HTTP Response

Status Code Content Type Payload
200  OK application/json Teams List Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = 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);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let teamList = try await teams.list()
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.list(
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.list(
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • query {
        teamsList {
            total
            teams {
                _id
                _createdAt
                _updatedAt
                name
                total
            }
        }
    }
    
  • GET /v1/teams HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Get Team

GET/v1/teams/{teamId}

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

HTTP Request

Name Type Description
teamId required string

Team ID.

HTTP Response

Status Code Content Type Payload
200  OK application/json Team Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = 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);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let team = try await teams.get(
        teamId: "[TEAM_ID]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.get(
        teamId = "[TEAM_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.get(
        "[TEAM_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • query {
        teamsGet(
            teamId: "[TEAM_ID]"
        ) {
            _id
            _createdAt
            _updatedAt
            name
            total
        }
    }
    
  • GET /v1/teams/{teamId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Update Team

PUT/v1/teams/{teamId}

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

HTTP Request

Name Type Description
teamId required string

Team ID.

name required string

New team name. Max length: 128 chars.

HTTP Response

Status Code Content Type Payload
200  OK application/json Team Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = 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);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let team = try await teams.update(
        teamId: "[TEAM_ID]",
        name: "[NAME]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.update(
        teamId = "[TEAM_ID]",
        name = "[NAME]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.update(
        "[TEAM_ID]",
        "[NAME]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsUpdate(
            teamId: "[TEAM_ID]",
            name: "[NAME]"
        ) {
            _id
            _createdAt
            _updatedAt
            name
            total
        }
    }
    
  • PUT /v1/teams/{teamId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "name": "[NAME]"
    }
    

Delete Team

DELETE/v1/teams/{teamId}

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

HTTP Request

Name Type Description
teamId required string

Team ID.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = 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);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let result = try await teams.delete(
        teamId: "[TEAM_ID]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.delete(
        teamId = "[TEAM_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.delete(
        "[TEAM_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsDelete(
            teamId: "[TEAM_ID]"
        ) {
            status
        }
    }
    
  • DELETE /v1/teams/{teamId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Create Team Membership

POST/v1/teams/{teamId}/memberships

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.

Rate Limits

This endpoint is limited to 10 requests in every 60 minutes per IP address. We use rate limits to avoid service abuse by users and as a security practice. Learn more about rate limiting.

HTTP Request

Name Type Description
teamId required string

Team ID.

email required string

Email of the new team member.

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. Maximum of 100 roles are allowed, each 32 characters long.

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

Name of the new team member. Max length: 128 chars.

HTTP Response

Status Code Content Type Payload
201  Created application/json Membership Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = 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);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let membership = try await teams.createMembership(
        teamId: "[TEAM_ID]",
        email: "email@example.com",
        roles: [],
        url: "https://example.com"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.createMembership(
        teamId = "[TEAM_ID]",
        email = "email@example.com",
        roles = listOf(),
        url = "https://example.com",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.createMembership(
        "[TEAM_ID]",
        "email@example.com",
        listOf(),
        "https://example.com",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsCreateMembership(
            teamId: "[TEAM_ID]",
            email: "email@example.com",
            roles: [],
            url: "https://example.com"
        ) {
            _id
            _createdAt
            _updatedAt
            userId
            userName
            userEmail
            teamId
            teamName
            invited
            joined
            confirm
            roles
        }
    }
    
  • POST /v1/teams/{teamId}/memberships HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "email": "email@example.com",
      "roles": [],
      "url": "https://example.com",
      "name": "[NAME]"
    }
    

List Team Memberships

GET/v1/teams/{teamId}/memberships

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

HTTP Request

Name Type Description
teamId required string

Team ID.

queries optional 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 optional string

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

HTTP Response

Status Code Content Type Payload
200  OK application/json Memberships List Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.listMemberships('[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.listMemberships(
        teamId: '[TEAM_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let membershipList = try await teams.listMemberships(
        teamId: "[TEAM_ID]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.listMemberships(
        teamId = "[TEAM_ID]",
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.listMemberships(
        "[TEAM_ID]",
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • query {
        teamsListMemberships(
            teamId: "[TEAM_ID]"
        ) {
            total
            memberships {
                _id
                _createdAt
                _updatedAt
                userId
                userName
                userEmail
                teamId
                teamName
                invited
                joined
                confirm
                roles
            }
        }
    }
    
  • GET /v1/teams/{teamId}/memberships HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Get Team Membership

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

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

HTTP Request

Name Type Description
teamId required string

Team ID.

membershipId required string

Membership ID.

HTTP Response

Status Code Content Type Payload
200  OK application/json Membership Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.getMembership('[TEAM_ID]', '[MEMBERSHIP_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.getMembership(
        teamId: '[TEAM_ID]',
        membershipId: '[MEMBERSHIP_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let membership = try await teams.getMembership(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.getMembership(
        teamId = "[TEAM_ID]",
        membershipId = "[MEMBERSHIP_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.getMembership(
        "[TEAM_ID]",
        "[MEMBERSHIP_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • query {
        teamsGetMembership(
            teamId: "[TEAM_ID]",
            membershipId: "[MEMBERSHIP_ID]"
        ) {
            _id
            _createdAt
            _updatedAt
            userId
            userName
            userEmail
            teamId
            teamName
            invited
            joined
            confirm
            roles
        }
    }
    
  • GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    

Update Membership Roles

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

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.

HTTP Request

Name Type Description
teamId required string

Team ID.

membershipId required string

Membership ID.

roles required array

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.

HTTP Response

Status Code Content Type Payload
200  OK application/json Membership Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.updateMembershipRoles('[TEAM_ID]', '[MEMBERSHIP_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.updateMembershipRoles(
        teamId: '[TEAM_ID]',
        membershipId: '[MEMBERSHIP_ID]',
        roles: [],
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let membership = try await teams.updateMembershipRoles(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]",
        roles: []
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.updateMembershipRoles(
        teamId = "[TEAM_ID]",
        membershipId = "[MEMBERSHIP_ID]",
        roles = listOf()
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.updateMembershipRoles(
        "[TEAM_ID]",
        "[MEMBERSHIP_ID]",
        listOf()
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsUpdateMembershipRoles(
            teamId: "[TEAM_ID]",
            membershipId: "[MEMBERSHIP_ID]",
            roles: []
        ) {
            _id
            _createdAt
            _updatedAt
            userId
            userName
            userEmail
            teamId
            teamName
            invited
            joined
            confirm
            roles
        }
    }
    
  • PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "roles": []
    }
    

Update Team Membership Status

PATCH/v1/teams/{teamId}/memberships/{membershipId}/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.

HTTP Request

Name Type Description
teamId required string

Team ID.

membershipId required string

Membership ID.

userId required string

User ID.

secret required string

Secret key.

HTTP Response

Status Code Content Type Payload
200  OK application/json Membership Object
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.updateMembershipStatus('[TEAM_ID]', '[MEMBERSHIP_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]',
        membershipId: '[MEMBERSHIP_ID]',
        userId: '[USER_ID]',
        secret: '[SECRET]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let membership = try await teams.updateMembershipStatus(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]",
        userId: "[USER_ID]",
        secret: "[SECRET]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.updateMembershipStatus(
        teamId = "[TEAM_ID]",
        membershipId = "[MEMBERSHIP_ID]",
        userId = "[USER_ID]",
        secret = "[SECRET]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.updateMembershipStatus(
        "[TEAM_ID]",
        "[MEMBERSHIP_ID]",
        "[USER_ID]",
        "[SECRET]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsUpdateMembershipStatus(
            teamId: "[TEAM_ID]",
            membershipId: "[MEMBERSHIP_ID]",
            userId: "[USER_ID]",
            secret: "[SECRET]"
        ) {
            _id
            _createdAt
            _updatedAt
            userId
            userName
            userEmail
            teamId
            teamName
            invited
            joined
            confirm
            roles
        }
    }
    
  • PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...
    
    {
      "userId": "[USER_ID]",
      "secret": "[SECRET]"
    }
    

Delete Team Membership

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

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.

HTTP Request

Name Type Description
teamId required string

Team ID.

membershipId required string

Membership ID.

HTTP Response

Status Code Content Type Payload
204  No Content - -
Example Request
  • import { Client, Teams } from "appwrite";
    
    const client = new Client();
    
    const teams = new Teams(client);
    
    client
        .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
        .setProject('5df5acd0d48c2') // Your project ID
    ;
    
    const promise = teams.deleteMembership('[TEAM_ID]', '[MEMBERSHIP_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]',
        membershipId: '[MEMBERSHIP_ID]',
      );
    
      result
        .then((response) {
          print(response);
        }).catchError((error) {
          print(error.response);
      });
    }
    
  • import Appwrite
    
    let client = Client()
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    let teams = Teams(client)
    
    let result = try await teams.deleteMembership(
        teamId: "[TEAM_ID]",
        membershipId: "[MEMBERSHIP_ID]"
    )
    
    
  • import io.appwrite.Client
    import io.appwrite.services.Teams
    
    val client = Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2") // Your project ID
    
    val teams = Teams(client)
    
    val response = teams.deleteMembership(
        teamId = "[TEAM_ID]",
        membershipId = "[MEMBERSHIP_ID]"
    )
    
  • import io.appwrite.Client;
    import io.appwrite.coroutines.CoroutineCallback;
    import io.appwrite.services.Teams;
    
    Client client = new Client(context)
        .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
        .setProject("5df5acd0d48c2"); // Your project ID
    
    Teams teams = new Teams(client);
    
    teams.deleteMembership(
        "[TEAM_ID]",
        "[MEMBERSHIP_ID]"
        new CoroutineCallback<>((result, error) -> {
            if (error != null) {
                error.printStackTrace();
                return;
            }
    
            Log.d("Appwrite", result.toString());
        })
    );
    
  • mutation {
        teamsDeleteMembership(
            teamId: "[TEAM_ID]",
            membershipId: "[MEMBERSHIP_ID]"
        ) {
            status
        }
    }
    
  • DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1
    Host: HOSTNAME
    Content-Type: application/json
    X-Appwrite-Response-Format: 1.0.0
    X-Appwrite-Project: 5df5acd0d48c2
    X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...