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

# List Estimates

> Get paginated list of estimates



## OpenAPI

````yaml GET /v1/estimates
openapi: 3.1.0
info:
  title: Blinksale API
  description: Official API for Blinksale - A modern invoicing solution
  version: 1.0.0
  contact:
    name: Blinksale Support
    url: https://blinksale.com/contact
    email: support@blinksale.com
servers:
  - url: https://app.blinksale.test/api
    description: Development server
  - url: https://blinksale.avenues.dev/api
    description: Staging server
  - url: https://app.blinksale.com/api
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Organizations
    description: Operations for managing organizations
  - name: Profile
    description: Operations for managing user profiles
  - name: Clients
    description: Operations for managing clients
  - name: Contacts
    description: Operations for managing client contacts
  - name: Estimates
    description: Operations for managing estimates
  - name: Invoices
    description: Operations for managing invoices
  - name: Payments
    description: Operations for managing payments
  - name: Recurring Invoices
    description: Operations for managing recurring invoices
  - name: Taxes
    description: Operations for managing tax rates
  - name: Units
    description: Operations for managing units of measurement
  - name: Saved Items
    description: Operations for managing saved items/products
  - name: Enums
    description: Operations for retrieving enumeration values
paths:
  /v1/estimates:
    get:
      tags:
        - Estimates
      summary: List estimates
      description: Returns a paginated list of estimates
      operationId: getEstimates
      parameters:
        - name: per_page
          in: query
          schema:
            type: integer
            default: 15
          description: Number of records per page
        - name: search
          in: query
          schema:
            type: string
          description: Search term to filter estimates
        - name: status
          in: query
          schema:
            type: string
          description: Filter by status (DRAFT, SENT, APPROVED, DECLINED, CONVERTED)
        - name: client_id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter by client ID
      responses:
        '200':
          description: Estimates retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponse'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Estimate'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Resources retrieved successfully
        data:
          type: array
          items:
            type: object
        meta:
          type: object
          properties:
            current_page:
              type: integer
              example: 1
            from:
              type: integer
              example: 1
            last_page:
              type: integer
              example: 5
            links:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                    nullable: true
                  label:
                    type: string
                  active:
                    type: boolean
            path:
              type: string
            per_page:
              type: integer
              example: 15
            to:
              type: integer
              example: 15
            total:
              type: integer
              example: 75
    Estimate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        organization_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        client_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        estimate_number:
          type: string
          example: EST-00001
        prefix:
          type: string
          example: EST-
        number:
          type: integer
          example: 1
        currency:
          type: string
          example: USD
        currency_name:
          type: string
          example: US Dollar
        currency_symbol:
          type: string
          example: $
        tax_id:
          type: string
          format: uuid
          nullable: true
          example: 01jtbf0c9zaraqx3swthf88n5y
        tax_name:
          type: string
          nullable: true
          example: Sales Tax
        tax_percent:
          type: number
          format: float
          nullable: true
          example: 8.5
        tax_distribution:
          type: string
          enum:
            - NO_TAX
            - PER_ITEM
            - PER_DOCUMENT
          example: PER_DOCUMENT
        tax_distribution_name:
          type: string
          example: Per Document
        discount_type:
          type: string
          enum:
            - PERCENTAGE
            - FIXED
          nullable: true
          example: PERCENTAGE
        discount_type_name:
          type: string
          nullable: true
          example: Percentage
        discount_value:
          type: number
          format: float
          nullable: true
          example: 10
        discount_distribution:
          type: string
          enum:
            - NO_DISCOUNT
            - PER_ITEM
            - PER_DOCUMENT
          example: PER_DOCUMENT
        discount_distribution_name:
          type: string
          example: Per Document
        shipping:
          type: number
          format: float
          nullable: true
          example: 15
        total:
          type: number
          format: float
          example: 1642.5
        notes:
          type: string
          nullable: true
          example: Please review and approve at your earliest convenience.
        options:
          type: object
          nullable: true
        status:
          type: string
          enum:
            - DRAFT
            - SENT
            - APPROVED
            - DECLINED
            - CONVERTED
          example: DRAFT
        status_name:
          type: string
          example: Draft
        is_editable:
          type: boolean
          example: true
        client:
          $ref: '#/components/schemas/Client'
        organization:
          $ref: '#/components/schemas/Organization'
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
        subtotal:
          type: number
          format: float
          example: 1500
        document_discount:
          type: number
          format: float
          example: 0
        tax_amount:
          type: number
          format: float
          example: 127.5
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        approved_at:
          type: string
          format: date-time
          nullable: true
        declined_at:
          type: string
          format: date-time
          nullable: true
        converted_at:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: An error occurred
        errors:
          type: object
          description: Validation errors by field
          example:
            email:
              - The email field is required.
    Client:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          example: Acme Inc
        email:
          type: string
          format: email
          example: billing@acme.com
        kind:
          type: string
          enum:
            - BUSINESS
            - PERSON
          example: BUSINESS
        kind_name:
          type: string
          example: Business
        profile:
          type: object
          nullable: true
          properties:
            company_name:
              type: string
              example: Acme Inc
            website:
              type: string
              example: https://acme.com
        address:
          $ref: '#/components/schemas/Address'
        document_defaults:
          type: object
          nullable: true
          properties:
            currency:
              type: string
              example: USD
        contact_count:
          type: integer
          example: 3
        note_count:
          type: integer
          example: 2
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Organization:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          example: Acme Inc
        stripe_id:
          type: string
          nullable: true
        subscription:
          $ref: '#/components/schemas/Subscription'
        profile:
          type: object
          nullable: true
        role:
          type: string
          enum:
            - OWNER
            - MEMBER
          example: OWNER
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    LineItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        organization_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          example: Consulting Services
        description:
          type: string
          nullable: true
          example: Professional consulting services
        quantity:
          type: number
          format: float
          example: 10
        price:
          type: number
          format: float
          example: 150
        unit_of_measurement_id:
          type: string
          format: uuid
          nullable: true
          example: 01jtbf0c9zaraqx3swthf88n5y
        unit_name:
          type: string
          nullable: true
          example: Hour
        tax_id:
          type: string
          format: uuid
          nullable: true
          example: 01jtbf0c9zaraqx3swthf88n5y
        tax_name:
          type: string
          nullable: true
          example: Sales Tax
        tax_percent:
          type: number
          format: float
          nullable: true
          example: 8.5
        discount_type:
          type: string
          enum:
            - PERCENTAGE
            - FIXED
          nullable: true
          example: PERCENTAGE
        discount_value:
          type: number
          format: float
          nullable: true
          example: 10
        subtotal:
          type: number
          format: float
          example: 1500
        tax_amount:
          type: number
          format: float
          example: 127.5
        total:
          type: number
          format: float
          example: 1627.5
    Address:
      type: object
      nullable: true
      properties:
        line1:
          type: string
          example: 123 Main St
        line2:
          type: string
          nullable: true
          example: Suite 101
        city:
          type: string
          example: San Francisco
        state:
          type: string
          example: CA
        zip:
          type: string
          example: '94107'
        country:
          type: string
          example: US
    Subscription:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - ACTIVE
            - CANCELED
            - EXPIRED
            - INCOMPLETE
            - PAST_DUE
            - PENDING
            - TRIAL
        plan:
          type: string
          enum:
            - FREE
            - BASIC
            - PREMIUM
            - ENTERPRISE
        trial_ends_at:
          type: string
          format: date-time
          nullable: true
        ends_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token obtained from the /v1/auth/login endpoint

````