Organization Admin API
Generated OpenAPI reference for the Organization Admin API surface.
Overview
Organization Admin endpoints are part of the public Everyn API. Browser-admin routes for organizations, members, invitations, API-key management, and audit events. API keys cannot call these admin routes.
Endpoints
The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag.
Endpoint summary for quick scanning before using the generated reference:
Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.
| Method | Path | Summary | Request body | Success response |
|---|---|---|---|---|
POST | /v1/invitations/{invitation_token}/accept | Accept Organization Invitation | None. | 200 application/json: OrganizationMemberResponse |
GET | /v1/me | Get Me | None. | 200 application/json: MeResponse |
PATCH | /v1/me | Update Me Profile | application/json: UserProfileUpdateRequest | 200 application/json: HumanUserResponse |
GET | /v1/organizations | List Organizations | None. | 200 application/json: Page_OrganizationResponse_ |
POST | /v1/organizations | Create Organization | application/json: OrganizationCreateRequest | 201 application/json: OrganizationResponse |
GET | /v1/organizations/{organization_id} | Get Organization | None. | 200 application/json: OrganizationResponse |
PATCH | /v1/organizations/{organization_id} | Update Organization | application/json: OrganizationUpdateRequest | 200 application/json: OrganizationResponse |
GET | /v1/organizations/{organization_id}/api-keys | List Organization Api Keys | None. | 200 application/json: Page_ApiKeyResponse_ |
POST | /v1/organizations/{organization_id}/api-keys | Create Organization Api Key | application/json: ApiKeyCreateRequest | 201 application/json: CreatedApiKeyResponse or ApiKeyResponse |
GET | /v1/organizations/{organization_id}/api-keys/{api_key_id} | Get Organization Api Key | None. | 200 application/json: ApiKeyResponse |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/revoke | Revoke Organization Api Key | None. | 200 application/json: ApiKeyResponse |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/rotate | Rotate Organization Api Key | application/json: ApiKeyRotateRequest or null | 200 application/json: CreatedApiKeyResponse |
GET | /v1/organizations/{organization_id}/audit-events | List Organization Audit Events | None. | 200 application/json: Page_AuditEventResponse_ |
GET | /v1/organizations/{organization_id}/audit-events/{audit_event_id} | Get Organization Audit Event | None. | 200 application/json: AuditEventResponse |
GET | /v1/organizations/{organization_id}/invitations | List Organization Invitations | None. | 200 application/json: Page_OrganizationInvitationResponse_ |
POST | /v1/organizations/{organization_id}/invitations | Create Organization Invitation | application/json: OrganizationInvitationCreateRequest | 201 application/json: CreatedOrganizationInvitationResponse or OrganizationInvitationResponse |
POST | /v1/organizations/{organization_id}/invitations/{invitation_id}/revoke | Revoke Organization Invitation | None. | 200 application/json: OrganizationInvitationResponse |
GET | /v1/organizations/{organization_id}/members | List Organization Members | None. | 200 application/json: Page_OrganizationMemberResponse_ |
GET | /v1/organizations/{organization_id}/members/{user_id} | Get Organization Member | None. | 200 application/json: OrganizationMemberResponse |
PATCH | /v1/organizations/{organization_id}/members/{user_id} | Update Organization Member | application/json: OrganizationMemberUpdateRequest | 200 application/json: OrganizationMemberResponse |
DELETE | /v1/organizations/{organization_id}/members/{user_id} | Remove Organization Member | None. | 200 application/json: OrganizationMemberResponse |
Loading API reference...