> ## 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 v1conversations ## OpenAPI ````yaml /api-reference/openapi.json get /v1/conversations 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: AgentEntryPoint - name: AgentLinks - name: AgentPanelEvent - name: AgentPanelSessions - name: AgentTestConversation - name: Analytics - name: ApiKey - name: Attachment - name: Auth - name: Billing - name: ChannelActivity - name: ChannelConfiguration - name: ChannelSettings - name: ConnectedApp - name: ContactSync - name: Conversation - name: ConversationAi - name: ConversationCustomerContext - name: ConversationDraft - name: ConversationMacro - name: ConversationOrder - name: CustomField - name: EmailMailbox - name: EmailPreferences - 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: Order - name: OrderAction - name: Plan - name: PolicyQuestion - name: Product - name: ProductPairing - name: Proposal - name: ReplyTemplate - name: RoutingRule - name: SavedView - name: Scenario - name: ScenarioBackfill - name: Schedule - name: SenderClassification - name: SenderRule - name: ShopifyStaffLinks - name: SlaPolicy - name: Team - name: Topic - name: TopicSuggestion - name: WebhookEndpoint - name: Widgets paths: /v1/conversations: get: tags: - Conversation operationId: conversation.index parameters: - name: page in: query required: false schema: type: integer minimum: 1 maximum: 500 - name: perPage in: query required: false schema: type: integer minimum: 1 maximum: 100 - name: sort in: query required: false schema: enum: - newest - oldest - waiting_longest - priority - sla_due - name: cursor in: query required: false description: >- The previous page's `metadata.nextCursor`, in the same `sort`; not with `page`. A cursor from another sort, or one that does not decode, answers 422 `invalid_cursor`. schema: type: string maxLength: 1000 - name: q in: query required: false schema: type: string minLength: 1 maxLength: 255 - name: view in: query required: false description: >- Only conversations in this inbox view, ANDed with the other filters: `needs_a_person`, `mine`, `unassigned`, `waiting`, `on_hold`, `closed`, `handled_by_aide`, `resolved_by_aide`, `handoffs`, `team:` (its conversations not closed or spam) or a saved view id. `drafts` and `suggested` filter on what conversations cannot be filtered by yet: a list answers 422 `unsupported_view_filter` and a count is null. schema: type: string minLength: 1 maxLength: 80 - name: status in: query required: false schema: type: array items: enum: - new - open - waiting_on_customer - on_hold - snoozed - closed - spam maxItems: 7 - name: statusNot in: query required: false schema: type: array items: enum: - new - open - waiting_on_customer - on_hold - snoozed - closed - spam maxItems: 7 - name: priority in: query required: false schema: type: array items: enum: - urgent - high - normal - low maxItems: 4 - name: priorityNot in: query required: false schema: type: array items: enum: - urgent - high - normal - low maxItems: 4 - name: handoffState in: query required: false schema: type: array items: enum: - aide_handling - handoff_requested - person_handling - returned_to_aide maxItems: 4 - name: handoffStateNot in: query required: false schema: type: array items: enum: - aide_handling - handoff_requested - person_handling - returned_to_aide maxItems: 4 - name: channel in: query required: false schema: type: array items: type: string maxLength: 40 maxItems: 20 - name: channelNot in: query required: false schema: type: array items: type: string maxLength: 40 maxItems: 20 - name: externalId in: query required: false schema: type: string minLength: 1 maxLength: 255 - name: assignee in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: assigneeNot in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: team in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: teamNot in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: topic in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: topicNot in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: scenario in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: slaStatus in: query required: false schema: type: array items: enum: - on_track - imminent - breached - achieved - paused - none maxItems: 6 - name: slaStatusNot in: query required: false schema: type: array items: enum: - on_track - imminent - breached - achieved - paused - none maxItems: 6 - name: trashed in: query required: false schema: enum: - '1' - 1 - 'true' - true - 'on' - '0' - 0 - 'false' - false - name: automated in: query required: false schema: enum: - '1' - 1 - 'true' - true - 'on' - '0' - 0 - 'false' - false - name: resolvedBy in: query required: false schema: enum: - aide - person - name: createdAfter in: query required: false schema: type: string format: date-time - name: createdBefore in: query required: false schema: type: string format: date-time - name: outcome in: query required: false description: >- Conversations the analytics reports count with one of these outcomes. With no `startedAfter`, `startedBefore`, `orderedAfter` or `orderedBefore`, only conversations started in the last 90 days are classified. schema: type: array items: enum: - eligible - resolved_confirmed - resolved_assumed - reopened - in_progress - manual - handed_off - topic_detected - not_routed - scenario_on_topic - scenario_applied - draft_used - human_engaged - csat_aide - csat_human - knowledge_gap - knowledge_gap_no_topic - ordered_from_cart - ordered_after_chat maxItems: 19 - name: handoffReason in: query required: false schema: type: array items: enum: - customer_asked - low_confidence - guardrail - missing_data - policy - manual - unspecified maxItems: 7 - name: detectedTopic in: query required: false schema: type: array items: type: string maxLength: 64 maxItems: 50 uniqueItems: true - name: startedAfter in: query required: false schema: type: string format: date-time - name: startedBefore in: query required: false schema: type: string format: date-time - name: orderedAfter in: query required: false schema: type: string format: date-time - name: orderedBefore in: query required: false schema: type: string format: date-time responses: '200': description: OK headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ConversationListItem' metadata: type: object properties: total: type: - number - 'null' totalIsCapped: type: boolean perPage: type: number currentPage: type: - number - 'null' lastPage: type: - number - 'null' hasMore: type: boolean nextCursor: type: - string - 'null' required: - total - totalIsCapped - perPage - currentPage - lastPage - hasMore - nextCursor required: - data - metadata '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 schemas: ConversationListItem: type: object properties: object: type: string const: conversation preview: type: string sla: type: - object - 'null' properties: status: type: string pausedReason: type: - string - 'null' breachedAt: type: - string - 'null' firstResponseDueAt: type: - string - 'null' firstResponseMetAt: type: - string - 'null' nextResponseDueAt: type: - string - 'null' policyId: type: string resolutionDueAt: type: - string - 'null' resolutionMetAt: type: - string - 'null' policyName: type: string required: - status - pausedReason - breachedAt - firstResponseDueAt - firstResponseMetAt - nextResponseDueAt - policyId - resolutionDueAt - resolutionMetAt - policyName createdAt: type: - string - 'null' id: type: string status: type: string updatedAt: type: - string - 'null' assignedToAide: type: boolean firstResponseAt: type: - string - 'null' handoffReason: type: - string - 'null' handoffState: type: string humanEngagedAt: type: - string - 'null' priority: type: string resolvedAt: type: - string - 'null' snoozedUntil: type: - string - 'null' subject: type: - string - 'null' waitingSince: type: - string - 'null' team: type: - object - 'null' properties: name: type: string id: type: string required: - name - id requester: type: - object - 'null' properties: email: type: - string - 'null' name: type: - string - 'null' visitorId: type: - string - 'null' required: - email - name - visitorId channel: type: string automated: type: boolean topic: type: - object - 'null' properties: name: type: string id: type: string emoji: type: - string - 'null' required: - name - id - emoji scenarioRan: type: boolean draftReady: type: boolean assignee: type: - object - 'null' properties: name: type: string id: type: string avatarUrl: type: - string - 'null' initials: type: string required: - name - id - avatarUrl - initials numMessages: type: number numMessagesRead: type: number latestMessageIsAgentReply: type: boolean latestMessageAt: type: string latestCustomerMessageAt: type: - string - 'null' firstCustomerMessageAt: type: - string - 'null' required: - object - preview - sla - createdAt - id - status - updatedAt - assignedToAide - firstResponseAt - handoffReason - handoffState - humanEngagedAt - priority - resolvedAt - snoozedUntil - subject - waitingSince - team - requester - channel - automated - topic - scenarioRan - draftReady - assignee - numMessages - numMessagesRead - latestMessageIsAgentReply - latestMessageAt - latestCustomerMessageAt - firstCustomerMessageAt 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 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' 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.