API
Organizations and members
Read and rename an organization, check what it still contains, delete it, and list its members.
Invites, membership changes and groups are in the Tenant API; keys are made in the identity app (Organizations).
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/members | Members with their role, email, name and join time, and the organization's teams with their size. Callers with members:write also get pending invites. |
GET /v1/orgs/:orgId | The organization's id, slug, name, kind and creation time. |
PATCH /v1/orgs/:orgId | Renames the organization. The slug doesn't change. |
GET /v1/orgs/:orgId/contents | What still has to be removed before the org can be deleted. |
DELETE /v1/orgs/:orgId | Deletes a customer org: owners only, and only once contents counts nothing (docs/cloud/org-deletion.md). Its data in every app goes with it: Notes pages (history, files and comments included), then each service's handler (purgeOrgData: Tasks, Customers, Marketing, Maps, Drive's folders, sharing, keys…), then members, teams, invites, API keys, the SES tenant and Exchange sign-ins. Data is deleted for a while per request: until it's all gone it answers 202 with what's left, the org and its members stay, and asking again goes on. A service that fails answers 503, the same. |