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

# List cases

> Returns all cases for your organization, newest first.



## OpenAPI

````yaml /partner-api/openapi.json get /cases
openapi: 3.0.3
info:
  title: TruEnroll Partner API
  version: 1.0.0
  description: >-
    Submit academic documents and retrieve structured extraction, forensics, and
    translation results.
servers:
  - url: https://eval-api.trential.dev/partner/v1
    description: Sandbox
  - url: https://api.truenroll.com/partner/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Cases
    description: Create and manage processing cases.
  - name: Results
    description: Fetch extraction, forensics, and translation results.
  - name: Webhooks
    description: Register endpoints that receive case events.
paths:
  /cases:
    get:
      tags:
        - Cases
      summary: List cases
      description: Returns all cases for your organization, newest first.
      operationId: listCases
      parameters:
        - name: externalId
          in: query
          schema:
            type: string
          description: Filter by your external reference.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Results per page.
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Pagination offset.
      responses:
        '200':
          description: Cases retrieved.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Case'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
        meta:
          type: object
          description: >-
            Optional metadata (e.g. pagination). Empty object when not
            applicable.
        data: {}
      required:
        - success
        - message
        - meta
        - data
    Case:
      type: object
      properties:
        id:
          type: string
        externalId:
          type: string
        status:
          $ref: '#/components/schemas/CaseStatus'
        uploads:
          type: array
          items:
            $ref: '#/components/schemas/Upload'
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/CaseCredential'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - externalId
        - status
        - uploads
        - credentials
        - createdAt
        - updatedAt
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
      required:
        - statusCode
        - message
    CaseStatus:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
      description: Processing status.
    Upload:
      type: object
      properties:
        uploadId:
          type: string
        status:
          $ref: '#/components/schemas/CaseStatus'
        classify:
          type: boolean
        features:
          type: array
          items:
            $ref: '#/components/schemas/UploadFeature'
        files:
          type: array
          items:
            $ref: '#/components/schemas/UploadFile'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - uploadId
        - status
        - classify
        - features
        - files
        - createdAt
        - updatedAt
    CaseCredential:
      type: object
      properties:
        credentialId:
          type: string
        uploadId:
          type: string
          nullable: true
        credentialType:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/CaseStatus'
      required:
        - credentialId
        - status
    UploadFeature:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/PartnerFeature'
        status:
          $ref: '#/components/schemas/FeatureStatus'
      required:
        - name
        - status
    UploadFile:
      type: object
      properties:
        fileId:
          type: string
        fileName:
          type: string
      required:
        - fileId
        - fileName
    PartnerFeature:
      type: string
      enum:
        - extraction
        - forensics
        - translation
    FeatureStatus:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
        - skipped
      description: >-
        Per-feature processing status. `skipped` means the feature was not run
        for this upload.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Partner API key. Also accepted as `Authorization: Bearer <key>`.'

````