> ## Documentation Index > Fetch the complete documentation index at: https://docs.aide.app/llms.txt > Use this file to discover all available pages before exploring further. # Get v1audit eventsexport ## OpenAPI ````yaml /api-reference/openapi.json get /v1/audit-events/export openapi: 3.1.0 info: title: Aide API version: '1' description: >- Aide's public API. The dashboard, personal access tokens and the MCP server all use these endpoints. **Authentication.** `Authorization: Bearer oat_…` (a teammate's access token) or `Authorization: Bearer aide_live_…` (a workspace API key, created by an owner or admin under Settings > Developers). Either is bound to one account; every resource is scoped to it, and another account's id answers 404. **API keys** act as the workspace, not as a teammate. Operations that list `apiKey` under security accept them; everything else (the session, `me`, members, teams, billing, conversations, saved views, notifications, helpdesk and widget settings, and API keys themselves) answers 403 `api_key_not_allowed`. A key with only the `read` scope gets 403 `insufficient_scope` on writes (every method but `GET`, except `POST /v1/knowledge/search`, which only reads). A revoked, expired or unknown key answers 401 `invalid_api_key`. Requests are rate limited per key. **Webhooks.** Each delivery is a `POST` of the event JSON with `Aide-Event-Id`, `Aide-Event-Type`, `Aide-Delivery-Attempt` and `Aide-Signature: t=,v1=`. `v1` is the HMAC-SHA256 of `${t}.${raw body}` keyed with the endpoint secret (`whsec_…`, the whole string). For 24 h after a rotation a second `v1`, signed with the previous secret, is included; accept the request if any `v1` matches and `t` is within 5 minutes. Answer 2xx within 10 s; anything else is retried with exponential backoff (8 attempts over about 4 h). An endpoint is disabled after 25 failed attempts in a row with no success for 24 h. Deduplicate on the event id. **Responses.** Successful bodies are wrapped as `{ data }`. Page-numbered lists add `metadata`: `total` (exact up to 10,000, then 10,000 with `totalIsCapped: true`), `totalIsCapped`, `perPage`, `currentPage`, `lastPage` and `hasMore`. `page` runs from 1 to 500, and a page that starts past the first 10,000 rows answers 422 `page_too_deep`. `GET /v1/conversations` also takes a `cursor` (not with `page`): its `metadata.nextCursor` pages on in the same sort without counting, and a cursor page has null `total`, `currentPage` and `lastPage`. Message threads page with `before` and `meta.nextCursor`. **Errors.** Every error is `{ error: { type, code, message, requestId, fields? } }`. Validation failures are 422 with one entry per field in `fields`. **Rate limits.** Throttled routes return `X-RateLimit-Limit` and `X-RateLimit-Remaining`; a 429 adds `Retry-After` and `X-RateLimit-Reset`. servers: - url: https://app-api.aide.app description: Aide API security: [] tags: - name: Account - name: Agent - name: AgentAnalytics - name: AgentEntryPoint - name: AgentInstruction - name: AgentLinks - name: AgentPanelEvent - name: AgentPanelSessions - name: AgentTestConversation - name: Analytics - name: ApiKey - name: Attachment - name: AuditEvent - name: Auth - name: Billing - name: ChannelActivity - name: ChannelConfiguration - name: ChannelSettings - name: CompanySuggestion - name: ConnectedApp - name: Connection - name: ContactSync - name: Conversation - name: ConversationAi - name: ConversationCustomerContext - name: ConversationDraft - name: ConversationMacro - name: ConversationOrder - name: CustomField - name: EmailCodes - name: EmailMailbox - name: EmailPreferences - name: EmailVerifications - name: GoogleSessions - name: HelpdeskSetting - name: Integration - name: IntegrationAiAgentRule - name: IntegrationSidebar - name: Invitation - name: KnowledgeCollection - name: KnowledgeDocument - name: KnowledgeEntity - name: KnowledgeSource - name: Macro - name: Me - name: Member - name: MessageFeedback - name: MessageSender - name: Notification - name: NotificationChannel - name: OauthAuthorization - name: OnboardingAnswerCheck - name: OnboardingBuild - name: OnboardingQuestionTag - name: OnboardingTopic - name: Order - name: OrderAction - name: Plan - name: PolicyQuestion - name: PosthogProjects - name: ProcedureDraft - name: ProcedurePublication - name: ProcedureTriggerCheck - name: ProcedureVersion - name: Product - name: ProductFeedback - name: ProductPairing - name: Proposal - name: RoutingRule - name: SavedView - name: Scenario - name: ScenarioBackfill - name: ScenarioEstimate - name: ScenarioPreview - name: Schedule - name: SenderClassification - name: SenderRule - name: SetupStatus - name: ShopifyStaffLinks - name: SiThread - name: SitePreview - name: SlaPolicy - name: Team - name: Topic - name: TopicSuggestion - name: WebhookEndpoint - name: Widgets paths: /v1/audit-events/export: get: tags: - AuditEvent operationId: audit_event.export parameters: - name: from in: query required: false schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: to in: query required: false schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: actor in: query required: false schema: type: string pattern: ^[a-z]+_[0-9a-hjkmnp-tv-z]{26}$ - name: resourceType in: query required: false schema: enum: - account - user - member - invitation - api_key - integration - subscription - webhook_endpoint - scenario - scenario_backfill - agent - agent_instruction - topic - topic_category - topic_suggestion - macro - reply_template - helpdesk_settings - routing_rule - sender_rule - sla_policy - schedule - saved_view - custom_field - widget - email_mailbox - email_domain - knowledge_source - knowledge_collection - knowledge_document - knowledge_entity - product - order_action - name: action in: query required: false schema: enum: - session.signed_in - session.signed_out - session.account_switched - session.password_reset - staff.access_granted - account.updated - member.joined - member.updated - member.removed - member.ownership_transferred - invitation.created - invitation.resent - invitation.revoked - api_key.created - api_key.revoked - integration.connected - integration.disconnected - integration.setup_completed - integration.inbox_updated - subscription.plan_changed - subscription.trial_ended - subscription.cancelled - subscription.cancellation_reverted - webhook_endpoint.created - webhook_endpoint.updated - webhook_endpoint.deleted - webhook_endpoint.secret_rotated - scenario.created - scenario.updated - scenario.deleted - scenario_backfill.created - scenario_backfill.started - scenario_backfill.cancelled - agent.created - agent.updated - agent.deleted - agent.duplicated - agent.deployed - agent.paused - agent.entry_point_assigned - agent.entry_point_removed - agent_instruction.created - agent_instruction.updated - agent_instruction.deleted - topic.created - topic.updated - topic.deleted - topic.example_added - topic.example_updated - topic.example_removed - topic_category.created - topic_category.renamed - topic_category.deleted - topic_suggestion.accepted - topic_suggestion.dismissed - macro.created - macro.updated - macro.deleted - reply_template.created - reply_template.updated - reply_template.deleted - integration.notifications_updated - integration.inbox_settings_updated - helpdesk_settings.updated - routing_rule.created - routing_rule.updated - routing_rule.deleted - sender_rule.created - sender_rule.updated - sender_rule.deleted - sla_policy.created - sla_policy.updated - sla_policy.deleted - schedule.created - schedule.updated - schedule.deleted - saved_view.created - saved_view.updated - saved_view.deleted - custom_field.created - custom_field.updated - custom_field.archived - custom_field.restored - custom_field.deleted - widget.updated - widget.secret_rotated - email_mailbox.created - email_mailbox.settings_updated - email_domain.added - email_domain.verified - knowledge_source.created - knowledge_source.updated - knowledge_source.deleted - knowledge_source.import_started - knowledge_collection.created - knowledge_collection.updated - knowledge_collection.deleted - knowledge_document.created - knowledge_document.updated - knowledge_document.deleted - knowledge_document.published - knowledge_document.unpublished - knowledge_document.moved - knowledge_entity.created - knowledge_entity.updated - knowledge_entity.deleted - product.pairing_added - product.pairing_removed - product.pairing_hidden - product.pairing_shown - order_action.approved - order_action.rejected - name: via in: query required: false schema: enum: - dashboard - api - mcp - agent_panel - shopify_admin - superintelligence - system responses: '204': description: No Content headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/TooManyRequests' default: $ref: '#/components/responses/Error' security: - accessToken: [] components: headers: X-RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. schema: type: integer Retry-After: description: Seconds until the window resets. schema: type: integer X-RateLimit-Reset: description: When the window resets. schema: type: string format: date-time responses: Unauthenticated: description: Missing or invalid credentials (`authentication_error`). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The credential may not do this (`permission_error`). content: application/json: schema: $ref: '#/components/schemas/Error' ValidationFailed: description: The request has invalid fields (`validation_failed`). content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Rate limited (`too_many_requests`). headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' Error: description: Any other error, in the same envelope. content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object description: Every error response, whatever the status (app/exceptions/handler.ts). properties: error: type: object properties: type: type: string enum: - api_error - authentication_error - invalid_request_error - permission_error - rate_limit_error code: type: string description: Stable, machine-readable error code. message: type: string requestId: type: string fields: type: array description: Per-field problems, on validation errors. items: type: object properties: field: type: string code: type: string message: type: string required: - field - code - message required: - type - code - message - requestId required: - error securitySchemes: accessToken: type: http scheme: bearer bearerFormat: oat_… description: An access token, bound to one account. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.