Appwrite

Appwrite 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. 19 operations across 9 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /teams List the teams I belong to · List teams #
Ask an LLM
“Which teams is the current user a member of?”
“Can I search my teams by name?”
Tell an agent
List the teams I'm a member of.
Search my teams for {search}.
POST /teams Create a team · Create team #
Ask an LLM
“How do I create a team in Appwrite?”
“Who becomes the owner when a new team is created?”
Tell an agent
Create a team named {name} with ID {teamId}.
Create team {teamId} called {name} and give me the roles {roles}.
GET /teams/{teamId} Get a team · Get team #
Ask an LLM
“What are the details of a specific team?”
“Can any team member read the team's details?”
Tell an agent
Get team {teamId}.
Show me the details of team {teamId}.
PUT /teams/{teamId} Rename a team · Update name #
Ask an LLM
“How do I rename a team?”
“Can I change a team's display name after creating it?”
Tell an agent
Rename team {teamId} to {name}.
Change the name of team {teamId} to {name}.
DELETE /teams/{teamId} Delete a team · Delete team #
Ask an LLM
“How do I delete a team entirely?”
“Who is allowed to delete a team?”
Tell an agent destructive · confirm first
Delete team {teamId}.
Permanently remove the team {teamId}.
GET /teams/{teamId}/installations List apps installed on a team · List Installations #
Ask an LLM
“Which apps are installed on my team?”
“Can a regular team member see the team's app installations?”
Tell an agent
List app installations on team {teamId}.
Show installed apps for team {teamId} matching {queries}.
POST /teams/{teamId}/installations Install an app on a team · Create Installation #
Ask an LLM
“How do I install an app on a team?”
“What scopes does an app get when it is installed on a team?”
Tell an agent
Install app {appId} on team {teamId}.
Install app {appId} on team {teamId} with authorization details {authorizationDetails}.
GET /teams/{teamId}/installations/{installationId} Get an app installation on a team · Get Installation #
Ask an LLM
“What scopes were granted to a specific app installation on my team?”
“Can I look up one team app installation by ID?”
Tell an agent
Get installation {installationId} on team {teamId}.
Show the details of app installation {installationId}.
PUT /teams/{teamId}/installations/{installationId} Refresh an app installation's grants · Update Installation #
Ask an LLM
“How do I refresh an installed app's scopes after it requests new ones?”
“Are old installation access tokens revoked when I update an installation?”
Tell an agent
Refresh the scopes of installation {installationId} on team {teamId}.
Update installation {installationId} on {teamId} with authorization details {authorizationDetails}.
DELETE /teams/{teamId}/installations/{installationId} Uninstall an app from a team · Delete Installation #
Ask an LLM
“How do I uninstall an app from my team?”
“What happens to an app's access tokens when I remove it from a team?”
Tell an agent destructive · confirm first
Uninstall installation {installationId} from team {teamId}.
Remove app installation {installationId} and revoke its tokens.
GET /teams/{teamId}/logs List a team's activity logs · List team logs #
Ask an LLM
“What activity has happened on my team recently?”
“Can I see an audit log of changes to a team?”
Tell an agent
List activity logs for team {teamId}.
Show team {teamId} logs matching {queries}.
GET /teams/{teamId}/memberships List a team's members · List team memberships #
Ask an LLM
“Who are the members of my team?”
“Can I search a team's members by name or email?”
Tell an agent
List the members of team {teamId}.
Search team {teamId} members for {search}.
POST /teams/{teamId}/memberships Invite someone to a team · Create team membership #
Ask an LLM
“How do I invite a new member to my team by email?”
“Can I add someone to a team using just their phone number?”
Tell an agent
Invite {email} to team {teamId} with roles {roles}.
Add user {userId} to team {teamId} as {roles}.
GET /teams/{teamId}/memberships/{membershipId} Get a team member's membership · Get team membership #
Ask an LLM
“What roles does a particular member have on my team?”
“Has a specific team invitation been accepted?”
Tell an agent
Get membership {membershipId} on team {teamId}.
Show the roles for membership {membershipId}.
PATCH /teams/{teamId}/memberships/{membershipId} Change a team member's roles · Update team membership #
Ask an LLM
“How do I promote a team member to owner?”
“Who can change the roles of team members?”
Tell an agent
Set the roles of membership {membershipId} on team {teamId} to {roles}.
Change member {membershipId} in {teamId} to roles {roles}.
DELETE /teams/{teamId}/memberships/{membershipId} Remove a member from a team · Delete team membership #
Ask an LLM
“How do I remove someone from my team?”
“Can I cancel a team invitation that hasn't been accepted yet?”
Tell an agent destructive · confirm first
Remove membership {membershipId} from team {teamId}.
Leave team {teamId} by deleting my membership {membershipId}.
PATCH /teams/{teamId}/memberships/{membershipId}/status Accept a team invitation · Update team membership status #
Ask an LLM
“How does a user accept a team invite after clicking the email link?”
“Does accepting a team invitation log the user in?”
Tell an agent
Accept invitation {membershipId} to team {teamId} for user {userId} with secret {secret}.
Confirm user {userId} joining team {teamId} using membership {membershipId} and secret {secret}.
GET /teams/{teamId}/prefs Get a team's shared preferences · Get team preferences #
Ask an LLM
“What shared settings are stored for my team?”
“Can I read the preferences all team members share?”
Tell an agent
Get the preferences of team {teamId}.
Show shared prefs for team {teamId}.
PUT /teams/{teamId}/prefs Replace a team's shared preferences · Update team preferences #
Ask an LLM
“How do I save shared settings for a whole team?”
“Is there a size limit on team preferences?”
Tell an agent
Set the preferences of team {teamId} to {prefs}.
Replace team {teamId} shared prefs with {prefs}.

Documentation

📖
Documentation
https://appwrite.io/docs
📖
APIReference
https://appwrite.io/docs/references

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-teams-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/appwrite/appwrite

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-teams-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/appwrite:appwrite-teams-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

appwrite-teams-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: Appwrite Teams API
  description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to https://appwrite.io/docs
  termsOfService: https://appwrite.io/policy/terms
  contact:
    name: Appwrite Team
    url: https://appwrite.io/support
    email: team@appwrite.io
  license:
    name: BSD-3-Clause
    url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
  description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
  description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
  variables:
    region:
      default: fra
      description: Appwrite Cloud region.
tags:


# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-teams-api-openapi.yml