> ## 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 v1orders ## OpenAPI ````yaml /api-reference/openapi.json get /v1/orders 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/orders: get: tags: - Order operationId: order.index parameters: - name: email in: query required: false schema: type: string format: email maxLength: 254 - name: orderNumber in: query required: false schema: type: string minLength: 1 maxLength: 64 - 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: 20 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/Order' metadata: $ref: '#/components/schemas/PaginationMeta' 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: [] - apiKey: [] 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: Order: type: object properties: number: type: - number - 'null' object: type: string const: order name: type: - string - 'null' tags: type: array items: type: string createdAt: type: - string - 'null' id: type: string total: type: - string - 'null' currency: type: - string - 'null' note: type: - string - 'null' metafields: type: array items: type: object properties: url: type: - string - 'null' name: type: string value: type: string key: type: string references: type: array items: type: object properties: handle: type: - string - 'null' url: type: - string - 'null' kind: type: string enum: - collection - file - image - metaobject - other - product title: type: - string - 'null' required: - handle - url - kind - title type: type: string namespace: type: string display: type: string required: - url - name - value - key - references - type - namespace - display financialStatus: type: - string - 'null' fulfillmentStatus: type: string enum: - cancelled - fulfilled - partial - unfulfilled - unknown items: type: array items: type: object properties: id: type: string title: type: string imageUrl: type: - string - 'null' price: type: - string - 'null' quantity: type: number sku: type: - string - 'null' variantTitle: type: - string - 'null' fulfilledQuantity: type: number unfulfilledQuantity: type: number required: - id - title - imageUrl - price - quantity - sku - variantTitle - fulfilledQuantity - unfulfilledQuantity refunded: type: - string - 'null' cancelledAt: type: - string - 'null' shippingAddress: type: - object - 'null' properties: name: type: - string - 'null' phone: type: - string - 'null' zip: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' city: type: - string - 'null' province: type: - string - 'null' country: type: - string - 'null' countryCode: type: - string - 'null' required: - name - phone - zip - address1 - address2 - city - province - country - countryCode adminUrl: type: - string - 'null' currentTotal: type: - string - 'null' refundable: type: - string - 'null' fulfillments: type: array items: type: object properties: number: type: - string - 'null' url: type: - string - 'null' name: type: - string - 'null' createdAt: type: - string - 'null' id: type: string status: type: - string - 'null' events: type: array items: type: object properties: source: type: string enum: - carrier - shopify status: type: - string - 'null' message: type: - string - 'null' location: type: - string - 'null' happenedAt: type: string required: - source - status - message - location - happenedAt deliveredAt: type: - string - 'null' carrier: type: - string - 'null' items: type: array items: type: object properties: title: type: string quantity: type: number lineItemId: type: - string - 'null' required: - title - quantity - lineItemId estimatedDeliveryAt: type: - string - 'null' lastEvent: type: - object - 'null' properties: text: type: string happenedAt: type: string required: - text - happenedAt required: - number - url - name - createdAt - id - status - events - deliveredAt - carrier - items - estimatedDeliveryAt - lastEvent required: - number - object - name - tags - createdAt - id - total - currency - note - metafields - financialStatus - fulfillmentStatus - items - refunded - cancelledAt - shippingAddress - adminUrl - currentTotal - refundable - fulfillments PaginationMeta: type: object properties: total: type: integer description: >- Matching rows, exact up to 10,000; past that, 10,000 with `totalIsCapped`. totalIsCapped: type: boolean description: More rows match than `total` says. perPage: type: integer currentPage: type: integer lastPage: type: integer description: The last page `total` reaches. hasMore: type: boolean description: Another page follows this one. required: - total - totalIsCapped - perPage - currentPage - lastPage - hasMore 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. apiKey: type: http scheme: bearer bearerFormat: aide_live_… description: >- A workspace API key. Acts as the workspace with the `read` and/or `write` scope; never as a teammate. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.