Skip to content

Appwrite API

by appwrite.io

API keyHTTPSDevelopment
Open documentation ↗

Overview

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](https://appwrite.io/docs)

Appwrite is a development API from appwrite.io. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 100 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Development
Base URL
https://appwrite.io/v1
Version
0.9.3
Endpoints
100
Spec updated
2021-08-12

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://appwrite.io/v1/account" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://appwrite.io/v1/account", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://appwrite.io/v1/account",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/accountGet Account
POST/accountCreate Account
DELETE/accountDelete Account
PATCH/account/emailUpdate Account Email
POST/account/jwtCreate Account JWT
GET/account/logsGet Account Logs
PATCH/account/nameUpdate Account Name
PATCH/account/passwordUpdate Account Password
GET/account/prefsGet Account Preferences
PATCH/account/prefsUpdate Account Preferences
POST/account/recoveryCreate Password Recovery
PUT/account/recoveryComplete Password Recovery
GET/account/sessionsGet Account Sessions
POST/account/sessionsCreate Account Session
DELETE/account/sessionsDelete All Account Sessions
POST/account/sessions/anonymousCreate Anonymous Session
GET/account/sessions/oauth2/{provider}Create Account Session with OAuth2
GET/account/sessions/{sessionId}Get Session By ID
DELETE/account/sessions/{sessionId}Delete Account Session
POST/account/verificationCreate Email Verification
PUT/account/verificationComplete Email Verification
GET/avatars/browsers/{code}Get Browser Icon
GET/avatars/credit-cards/{code}Get Credit Card Icon
GET/avatars/faviconGet Favicon
GET/avatars/flags/{code}Get Country Flag
GET/avatars/imageGet Image from URL
GET/avatars/initialsGet User Initials
GET/avatars/qrGet QR Code
GET/database/collections/{collectionId}/documentsList Documents
POST/database/collections/{collectionId}/documentsCreate Document
GET/database/collections/{collectionId}/documents/{documentId}Get Document
PATCH/database/collections/{collectionId}/documents/{documentId}Update Document
DELETE/database/collections/{collectionId}/documents/{documentId}Delete Document
GET/functions/{functionId}/executionsList Executions
POST/functions/{functionId}/executionsCreate Execution
GET/functions/{functionId}/executions/{executionId}Get Execution
GET/localeGet User Locale
GET/locale/continentsList Continents
GET/locale/countriesList Countries
GET/locale/countries/euList EU Countries
GET/locale/countries/phonesList Countries Phone Codes
GET/locale/currenciesList Currencies
GET/locale/languagesList Languages
GET/storage/filesList Files
POST/storage/filesCreate File
GET/storage/files/{fileId}Get File
PUT/storage/files/{fileId}Update File
DELETE/storage/files/{fileId}Delete File
GET/storage/files/{fileId}/downloadGet File for Download
GET/storage/files/{fileId}/previewGet File Preview
GET/storage/files/{fileId}/viewGet File for View
GET/teamsList Teams
POST/teamsCreate Team
GET/teams/{teamId}Get Team
PUT/teams/{teamId}Update Team
DELETE/teams/{teamId}Delete Team
GET/teams/{teamId}/membershipsGet Team Memberships
POST/teams/{teamId}/membershipsCreate Team Membership
PATCH/teams/{teamId}/memberships/{membershipId}Update Membership Roles
DELETE/teams/{teamId}/memberships/{membershipId}Delete Team Membership
PATCH/teams/{teamId}/memberships/{membershipId}/statusUpdate Team Membership Status
GET/database/collectionsList Collections
POST/database/collectionsCreate Collection
GET/database/collections/{collectionId}Get Collection
PUT/database/collections/{collectionId}Update Collection
DELETE/database/collections/{collectionId}Delete Collection
GET/functionsList Functions
POST/functionsCreate Function
GET/functions/{functionId}Get Function
PUT/functions/{functionId}Update Function
DELETE/functions/{functionId}Delete Function
PATCH/functions/{functionId}/tagUpdate Function Tag
GET/functions/{functionId}/tagsList Tags
POST/functions/{functionId}/tagsCreate Tag
GET/functions/{functionId}/tags/{tagId}Get Tag
DELETE/functions/{functionId}/tags/{tagId}Delete Tag
GET/healthGet HTTP
GET/health/anti-virusGet Anti virus
GET/health/cacheGet Cache
GET/health/dbGet DB
GET/health/queue/certificatesGet Certificate Queue
GET/health/queue/functionsGet Functions Queue
GET/health/queue/logsGet Logs Queue
GET/health/queue/tasksGet Tasks Queue
GET/health/queue/usageGet Usage Queue
GET/health/queue/webhooksGet Webhooks Queue
GET/health/storage/localGet Local Storage
GET/health/timeGet Time
GET/usersList Users
POST/usersCreate User
GET/users/{userId}Get User
DELETE/users/{userId}Delete User
GET/users/{userId}/logsGet User Logs
GET/users/{userId}/prefsGet User Preferences
PATCH/users/{userId}/prefsUpdate User Preferences
GET/users/{userId}/sessionsGet User Sessions
DELETE/users/{userId}/sessionsDelete User Sessions
DELETE/users/{userId}/sessions/{sessionId}Delete User Session
PATCH/users/{userId}/statusUpdate User Status
PATCH/users/{userId}/verificationUpdate Email Verification

Questions

Does the Appwrite API need an API key?

Yes. The Appwrite API uses API key authentication; the documentation explains how to get credentials.

Does the Appwrite API support HTTPS?

Yes, the Appwrite API is served over HTTPS.

How many endpoints does the Appwrite API have?

Its OpenAPI description lists 100 endpoints in version 0.9.3. All of them are shown on this page.

What are alternatives to the Appwrite API?

Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.

Compare alternatives →

Listed from APIs.guru (CC0).