Organizations
Manage organizations, team members, roles, and invitations. Organizations are the top-level billing and access control unit in Aether.
Authorization
ApiKeyAuth API key from your Aether dashboard
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/organization"{ "success": true, "data": { "id": "string", "name": "string", "slug": "string", "plan": "free", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}Authorization
ApiKeyAuth API key from your Aether dashboard
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/organization" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "data": { "id": "string", "name": "string", "slug": "string", "plan": "free", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}Authorization
ApiKeyAuth API key from your Aether dashboard
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/organization/members"{ "success": true, "data": [ { "userId": "string", "email": "user@example.com", "name": "string", "role": "owner", "joinedAt": "2019-08-24T14:15:22Z" } ]}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}Removes the user from the organization. Only owners and admins can remove members.
Authorization
ApiKeyAuth API key from your Aether dashboard
In: header
Path Parameters
Response Body
application/json
application/json
curl -X DELETE "https://example.com/organization/members/string"{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}Sends an email invitation to the specified address. The invitee receives a magic link that creates their account and adds them to the organization. Invites expire after 7 days.
Authorization
ApiKeyAuth API key from your Aether dashboard
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/organization/invites" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "role": "admin" }'{ "success": true}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}{ "success": false, "error": { "code": "PROFILE_NOT_FOUND", "message": "string", "details": {} }}