Appwrite

Appwrite Account API

The Account service allows you to authenticate and manage a user account. 73 operations across 47 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 73

GET /account Get account #
POST /account Create account #
DELETE /account Delete account #
GET /account/billing-addresses List billing addresses #
POST /account/billing-addresses Create billing address #
GET /account/billing-addresses/{billingAddressId} Get billing address #
PUT /account/billing-addresses/{billingAddressId} Update billing address #
DELETE /account/billing-addresses/{billingAddressId} Delete billing address #
GET /account/consents List consents #
GET /account/consents/{consentId} Get consent #
DELETE /account/consents/{consentId} Delete consent #
GET /account/consents/{consentId}/tokens List consent tokens #
GET /account/consents/{consentId}/tokens/{tokenId} Get consent token #
DELETE /account/consents/{consentId}/tokens/{tokenId} Delete consent token #
GET /account/coupons/{couponId} Get coupon details #
PATCH /account/email Update email #
GET /account/identities List identities #
DELETE /account/identities/{identityId} Delete identity #
GET /account/invoices List invoices #
POST /account/jwts Create JWT #
GET /account/keys List account key #
POST /account/keys Create account key #
GET /account/keys/{keyId} Get account key #
PUT /account/keys/{keyId} Update account key #
DELETE /account/keys/{keyId} Delete account key #
GET /account/logs List logs #
PATCH /account/mfa Update MFA #
POST /account/mfa/authenticators/{type} Create authenticator #
PUT /account/mfa/authenticators/{type} Update authenticator (confirmation) #
DELETE /account/mfa/authenticators/{type} Delete authenticator #
POST /account/mfa/challenges Create MFA challenge #
PUT /account/mfa/challenges Update MFA challenge (confirmation) #
GET /account/mfa/factors List factors #
GET /account/mfa/recovery-codes List MFA recovery codes #
POST /account/mfa/recovery-codes Create MFA recovery codes #
PATCH /account/mfa/recovery-codes Update MFA recovery codes (regenerate) #
PATCH /account/name Update name #
PATCH /account/password Update password #
GET /account/payment-methods List payment methods #
POST /account/payment-methods Create new payment method #
GET /account/payment-methods/{paymentMethodId} Get payment method #
PATCH /account/payment-methods/{paymentMethodId} Update payment method #
DELETE /account/payment-methods/{paymentMethodId} Delete payment method #
PATCH /account/payment-methods/{paymentMethodId}/provider Update payment method provider id #
PATCH /account/payment-methods/{paymentMethodId}/setup Update payment method with new setup with mandates for indian cards #
PATCH /account/phone Update phone #
GET /account/prefs Get account preferences #
PATCH /account/prefs Update preferences #
POST /account/recovery Create password recovery #
PUT /account/recovery Update password recovery (confirmation) #
GET /account/sessions List sessions #
DELETE /account/sessions Delete sessions #
POST /account/sessions/anonymous Create anonymous session #
POST /account/sessions/email Create email password session #
PUT /account/sessions/magic-url Update magic URL session #
GET /account/sessions/oauth2/{provider} Create OAuth2 session #
PUT /account/sessions/phone Update phone session #
POST /account/sessions/token Create session #
GET /account/sessions/{sessionId} Get session #
PATCH /account/sessions/{sessionId} Update session #
DELETE /account/sessions/{sessionId} Delete session #
PATCH /account/status Update status #
POST /account/targets/push Create push target #
PUT /account/targets/{targetId}/push Update push target #
DELETE /account/targets/{targetId}/push Delete push target #
POST /account/tokens/email Create email token (OTP) #
POST /account/tokens/magic-url Create magic URL token #
GET /account/tokens/oauth2/{provider} Create OAuth2 token #
POST /account/tokens/phone Create phone token #
POST /account/verifications/email Create email verification #
PUT /account/verifications/email Update email verification (confirmation) #
POST /account/verifications/phone Create phone verification #
PUT /account/verifications/phone Update phone verification (confirmation) #

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-account-api-openapi.yml

SDKs

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/json-schema/user-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/json-structure/user-structure.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-account-overlay.yaml
🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/postman/appwrite-account-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/collections/appwrite-account-api.opencollection.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/examples/user-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/json-ld/appwrite-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/rules/appwrite-spectral-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/vocabulary/appwrite-vocabulary.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-account-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-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: Appwrite Account 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 (200 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-account-api-openapi.yml