Organization API_
Use the Appwrite Console Organization API to manage organizations, members, and org-level settings from your partner platform.
2 min read
The Organization API manages one organization and everything inside it: projects, members, app installations, and the organization's own API keys. Partner platforms call it from a backend to provision customer workspaces.
Authentication
Authenticate with a Partners key or a user's OAuth access token. A Partners key is bound to the organization that issued it, so every call applies to that organization and no other. Pass the organization ID with the key.
Operations
| Group | Operations | Scopes |
|---|---|---|
| Organization | get, update, delete | organization.read, organization.write |
| Projects | listProjects, createProject, getProject, updateProject, deleteProject | projects.read, projects.write |
| Members | listMemberships, createMembership, getMembership, updateMembership, deleteMembership | organization.memberships.read, organization.memberships.write |
| Keys | listKeys, createKey, getKey, updateKey, deleteKey | organization.keys.read, organization.keys.write |
| Installations | listInstallations, createInstallation, getInstallation, updateInstallation, deleteInstallation | organization.installations.read, organization.installations.write |
Billing, plans, and invoices are not part of this API and a Partners key cannot reach them.
Where each credential applies
A Partners key covers the organization and each project's existence, name, and region. It cannot read or write databases, storage, users, or functions. For work inside a project, create a project API key and see Project.
With OAuth connect, the access token carries the scopes the user granted, and the calls apply to the organization the user chose.
Next steps
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.