> ## Documentation Index
> Fetch the complete documentation index at: https://api.zenedu.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List orders

> Returns a paginated list of orders for the specified bot.



## OpenAPI

````yaml GET /api/v1/bot/{bot}/orders
openapi: 3.1.0
info:
  title: Zenedu API v1
  description: >-
    API for managing Telegram bots, subscribers, products, funnels, offers, and
    orders on the Zenedu platform.
  version: 1.0.0
servers:
  - url: https://app.zenedu.io
security:
  - bearerAuth: []
tags:
  - name: User
    description: Current user profile
  - name: Bots
    description: Bot management
  - name: Subscribers
    description: Subscriber management
  - name: Orders
    description: Order management
  - name: Products
    description: Product management
  - name: Funnels
    description: Funnel management
  - name: Offers
    description: Offer management
  - name: Links
    description: Link generation
  - name: Files
    description: File downloads
  - name: Zapier
    description: Zapier webhook management
  - name: Webhooks
    description: Account webhook subscriptions
  - name: Payment systems
    description: Account payment methods
  - name: Bot settings
    description: 'Bot configuration: email, branding, integrations, legal documents'
  - name: Commands
    description: Bot menu commands
  - name: Custom fields
    description: Subscriber custom fields
  - name: Folders
    description: Folders for products, funnels, channels and groups
  - name: Slugs
    description: Public link slugs
  - name: Funnel links
    description: Subscription links of a funnel
  - name: Coupons
    description: Coupon management
  - name: Subscriptions
    description: Recurring subscription management
  - name: Tasks
    description: Student task review
  - name: Broadcasts
    description: Broadcast messages
  - name: Automations
    description: Event-based automations
  - name: Affiliate
    description: Affiliate program management
  - name: Shop
    description: Bot shop draft and publication
  - name: Channels
    description: Telegram channels connected to the bot
  - name: Groups
    description: Telegram groups connected to the bot
  - name: Mini-app
    description: Telegram mini app configuration
  - name: Web
    description: Web app configuration
  - name: Telegram files
    description: Telegram file attachments for steps and broadcasts
paths:
  /api/v1/bot/{bot}/orders:
    get:
      tags:
        - Orders
      summary: List orders
      description: Returns a paginated list of orders for the specified bot.
      operationId: listOrders
      parameters:
        - name: bot
          in: path
          required: true
          description: Bot ID
          schema:
            type: integer
        - name: status
          in: query
          required: false
          description: Filter by order status
          schema:
            type: string
            enum:
              - paid
              - unconfirmed
              - cancelled
              - refunded
              - pending
            default: paid
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
            default: 30
      responses:
        '200':
          description: Paginated list of orders
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponse'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Order'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — lacks access to this bot
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PaginatedResponse:
      type: object
      properties:
        data:
          type: array
          items: {}
        links:
          type: object
          properties:
            first:
              type: string
              nullable: true
            last:
              type: string
              nullable: true
            prev:
              type: string
              nullable: true
            next:
              type: string
              nullable: true
        meta:
          type: object
          properties:
            current_page:
              type: integer
            from:
              type: integer
              nullable: true
            last_page:
              type: integer
            path:
              type: string
            per_page:
              type: integer
            to:
              type: integer
              nullable: true
            total:
              type: integer
    Order:
      type: object
      properties:
        id:
          type: integer
          description: Order ID
        uuid:
          type: string
          description: Order UUID
        number:
          type: string
          description: Order number
        offer_id:
          type: integer
          description: Associated offer ID
        offer_name:
          type: string
          description: Name of the offer
        price:
          type: number
          description: Order price
        currency:
          type: string
          description: Currency code (e.g. USD, EUR)
        type:
          type: string
          description: Order type
        payment_system_type:
          type: string
          nullable: true
          description: Payment system type identifier
        payment_system_name:
          type: string
          nullable: true
          description: Payment system display name
        status:
          type: string
          description: Current order status
        old_status:
          type: string
          nullable: true
          description: Previous order status
        status_changed_at:
          type: string
          format: date-time
          nullable: true
          description: When the status last changed
        created_at:
          type: string
          format: date-time
          description: Order creation timestamp
        email:
          type: string
          nullable: true
          description: Customer email
        phone:
          type: string
          nullable: true
          description: Customer phone
        subscriber:
          $ref: '#/components/schemas/Subscriber'
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Validation errors keyed by field name
    Subscriber:
      type: object
      properties:
        id:
          type: integer
          description: Subscriber ID
        user_id:
          type: integer
          description: Telegram user ID
        first_name:
          type: string
          description: First name
        last_name:
          type:
            - string
            - 'null'
          description: Last name
        username:
          type:
            - string
            - 'null'
          description: Telegram username
        phone:
          type:
            - string
            - 'null'
          description: Phone number
        email:
          type:
            - string
            - 'null'
          description: Email address
        notes:
          type:
            - string
            - 'null'
          description: Notes about the subscriber
        tags:
          type: string
          description: Comma-separated list of tag names, empty string if none
        is_active:
          type: boolean
          description: Whether the subscriber is active
        is_blocked:
          type: boolean
          description: Whether the subscriber is blocked
        last_active_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Last activity timestamp
        created_at:
          type: string
          format: date-time
          description: Subscription timestamp
        utm_tags:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
          description: UTM tags keyed by type
        custom_fields:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
          description: Custom field values keyed by field name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token from the Zenedu dashboard

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.