Organizations API
:::info Coming Soon This feature is under active development. The design below reflects our planned implementation. :::
The Organizations API will provide endpoints for creating and managing organizations, their members, and invitations.
Planned Endpoints
Organizations
| Method | Endpoint | Description |
|---|---|---|
POST | /api/organizations | Create a new organization |
GET | /api/organizations | List organizations for the current user |
GET | /api/organizations/:id | Get organization details |
PUT | /api/organizations/:id | Update an organization |
DELETE | /api/organizations/:id | Delete an organization |
Members
| Method | Endpoint | Description |
|---|---|---|
GET | /api/organizations/:id/members | List organization members |
PUT | /api/organizations/:id/members/:user_id | Update a member's role |
DELETE | /api/organizations/:id/members/:user_id | Remove a member |
Invitations
| Method | Endpoint | Description |
|---|---|---|
POST | /api/organizations/:id/invitations | Create an invitation |
GET | /api/organizations/:id/invitations | List pending invitations |
DELETE | /api/organizations/:id/invitations/:invitation_id | Revoke an invitation |
POST | /api/organizations/:id/invitations/:invitation_id/accept | Accept an invitation |
Related
- Organizations — Overview and concepts
- Membership & Invitations — Membership and invitation flows
- Organization Roles — Role-based access within organizations