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

# List cases

> Returns a paginated list of cases. Archived cases are excluded unless includeArchived=true.



## OpenAPI

````yaml https://v2.proconvey.co.uk/api/v2/doc get /api/v2/cases
openapi: 3.1.0
info:
  title: ProConvey Public API
  version: '2.0'
  description: Public API for case management.
servers: []
security: []
tags:
  - name: Cases
    description: Case management operations including creation, retrieval, and data access
  - name: Clients
    description: Client records for the organisation
  - name: Webhooks
    description: >-
      Webhooks available for receiving updates of events on the ProConvey
      platform
  - name: Organisations
    description: Organization management and setup
  - name: System
    description: System and utility endpoints including branches and documentation
paths:
  /api/v2/cases:
    get:
      tags:
        - Cases
      summary: List cases
      description: >-
        Returns a paginated list of cases. Archived cases are excluded unless
        includeArchived=true.
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
          description: Page number (1-based)
        - in: query
          name: pageSize
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Page size (default 20, max 100)
        - in: query
          name: includeArchived
          schema:
            type: boolean
          description: Include archived cases (soft-deleted)
      responses:
        '200':
          description: Paginated list of cases
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                    description: Current page number
                  pageSize:
                    type: integer
                    description: Number of items per page
                  total:
                    type: integer
                    description: Total number of cases
                  items:
                    type: array
                    description: Array of case objects
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Case ID
                        type:
                          type: string
                          description: Case type (Sale, Purchase, Remortgage, Transfer)
                        branchId:
                          type: string
                          description: Branch ID
                        feeEarnerId:
                          type: string
                          description: Fee earner ID
                        propertyPrice:
                          type: number
                          description: Property price
                        propertyCurrency:
                          type: string
                          description: Property currency (typically GBP)
                        reference:
                          type: string
                          description: Case reference
                        createdAt:
                          type: string
                          format: date-time
                          description: Case creation timestamp
                        archivedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: Case archive timestamp (null if not archived)

````