APIReference
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. The static summary keeps the endpoint purpose, authentication, schema names, and API error guidance available before the interactive reference loads.
The details below are static HTML generated from the same OpenAPI schema, so they remain readable without client-side JavaScript. The interactive component after this section provides expandable examples and richer schema browsing.
Endpoint summary for quick scanning before using the generated reference:
| Method | Path | Purpose | Authentication | Request body / schema | Success response / schema | Errors |
|---|---|---|---|---|---|---|
POST | /v1/invitations/{invitation_token}/accept | Accept Organization Invitation | Bearer token (BearerAuth) | None. | 200 application/json: OrganizationMemberResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/me | Get Me | Bearer token (BearerAuth) | None. | 200 application/json: MeResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/me | Update Me Profile | Bearer token (BearerAuth) | application/json: UserProfileUpdateRequest | 200 application/json: HumanUserResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations | List Organizations | Bearer token (BearerAuth) | None. | 200 application/json: Page_OrganizationResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations | Create Organization | Bearer token (BearerAuth) | application/json: OrganizationCreateRequest | 201 application/json: OrganizationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id} | Get Organization | Bearer token (BearerAuth) | None. | 200 application/json: OrganizationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/organizations/{organization_id} | Update Organization | Bearer token (BearerAuth) | application/json: OrganizationUpdateRequest | 200 application/json: OrganizationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/api-keys | List Organization Api Keys | Bearer token (BearerAuth) | None. | 200 application/json: Page_ApiKeyResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys | Create Organization Api Key | Bearer token (BearerAuth) | application/json: ApiKeyCreateRequest | 201 application/json: CreatedApiKeyResponse or ApiKeyResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/api-keys/{api_key_id} | Get Organization Api Key | Bearer token (BearerAuth) | None. | 200 application/json: ApiKeyResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/revoke | Revoke Organization Api Key | Bearer token (BearerAuth) | None. | 200 application/json: ApiKeyResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/rotate | Rotate Organization Api Key | Bearer token (BearerAuth) | application/json: ApiKeyRotateRequest or null | 200 application/json: CreatedApiKeyResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/audit-events | List Organization Audit Events | Bearer token (BearerAuth) | None. | 200 application/json: Page_AuditEventResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/audit-events/{audit_event_id} | Get Organization Audit Event | Bearer token (BearerAuth) | None. | 200 application/json: AuditEventResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/invitations | List Organization Invitations | Bearer token (BearerAuth) | None. | 200 application/json: Page_OrganizationInvitationResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/invitations | Create Organization Invitation | Bearer token (BearerAuth) | application/json: OrganizationInvitationCreateRequest | 201 application/json: CreatedOrganizationInvitationResponse or OrganizationInvitationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/invitations/{invitation_id}/revoke | Revoke Organization Invitation | Bearer token (BearerAuth) | None. | 200 application/json: OrganizationInvitationResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/members | List Organization Members | Bearer token (BearerAuth) | None. | 200 application/json: Page_OrganizationMemberResponse_ | API errors: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/members/{user_id} | Get Organization Member | Bearer token (BearerAuth) | None. | 200 application/json: OrganizationMemberResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/organizations/{organization_id}/members/{user_id} | Update Organization Member | Bearer token (BearerAuth) | application/json: OrganizationMemberUpdateRequest | 200 application/json: OrganizationMemberResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
DELETE | /v1/organizations/{organization_id}/members/{user_id} | Remove Organization Member | Bearer token (BearerAuth) | None. | 200 application/json: OrganizationMemberResponse | API errors: 400, 401, 403, 404, 409, 422, 429 |
Loading API reference...