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

# List cases

> > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.

List cases visible to the caller. Internal cases that have never been routed to the partner are excluded. Supports filtering by parent, status, and kind, plus cursor-based pagination.



## OpenAPI

````yaml /api-reference/v1/openapi.json get /v1/case
openapi: 3.0.0
info:
  title: Palm Partner API
  description: >-
    The Palm API is identity verification and compliance infrastructure for US
    businesses: onboard businesses, verify businesses and people (KYB/KYC)
    against authoritative sources, monitor them for changes in real time, and
    act on their behalf through filings, formation, and registered agent
    services.
  version: '1.0'
  contact:
    name: Palm Support
    url: https://getpalm.com
    email: support@getpalm.com
  termsOfService: https://getpalm.com/terms
  license:
    name: Proprietary
    url: https://getpalm.com/license
servers:
  - url: https://api.getpalm.com
    description: Production
security: []
tags:
  - name: Registry
    description: Search business registries
  - name: Business
    description: Manage the businesses in your portfolio
  - name: User
    description: Manage the people in your portfolio
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
paths:
  /v1/case:
    get:
      tags:
        - Case
      summary: List cases
      description: >-
        > **⚠️ Early access** — This endpoint is in preview and may change in
        backwards-incompatible ways before it is marked stable. Avoid depending
        on it in production, and [reach out](mailto:support@getpalm.com) before
        building on it.


        List cases visible to the caller. Internal cases that have never been
        routed to the partner are excluded. Supports filtering by parent,
        status, and kind, plus cursor-based pagination.
      operationId: listCases
      parameters:
        - name: parent_type
          required: false
          in: query
          schema:
            enum:
              - filing
              - verification
              - business
              - session
            type: string
        - name: parent_id
          required: false
          in: query
          description: Filter by parent resource ID
          schema:
            type: string
        - name: status
          required: false
          in: query
          schema:
            enum:
              - needs_response
              - under_review
              - resolved
              - superseded
            type: string
        - name: kind
          required: false
          in: query
          schema:
            enum:
              - missing_information
              - ra_termination
            type: string
        - name: limit
          required: false
          in: query
          description: Max items (default 10, max 100)
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: Pagination cursor
          schema:
            type: string
      responses:
        '200':
          description: Paginated list of cases
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - has_more
                  - next_cursor
                  - data
                properties:
                  object:
                    type: string
                    enum:
                      - list
                    example: list
                    description: Object type identifier, always "list"
                  has_more:
                    type: boolean
                    example: true
                    description: Whether there are more results available
                  next_cursor:
                    type: string
                    nullable: true
                    example: crs_7g8h9i0j1k2l3m4n
                    description: >-
                      Cursor for the next page of results. Only present when
                      has_more is true.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Case'
                    description: Array of resources for the current page
      security:
        - ApiKey: []
components:
  schemas:
    Case:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        object:
          type: string
          description: Object type
          example: case
          enum:
            - case
        mode:
          type: string
          description: >-
            Whether this resource was created with test or live credentials.
            Test and live data are fully isolated — a test resource never
            appears in live results and vice versa.
          enum:
            - test
            - live
          example: live
        created_at:
          type: string
          description: ISO 8601 timestamp of when the resource was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the resource was last updated
          format: date-time
          example: '2025-10-24T15:45:00Z'
        metadata:
          type: object
          description: >-
            Store up to 50 custom key-value pairs for application-specific data.
            Useful for storing references to external systems, feature flags, or
            other custom attributes.
          additionalProperties:
            type: string
          example:
            external_id: user_123_in_my_system
            customer_tier: premium
            signup_source: mobile_app
        parent_type:
          type: string
          description: Type of the parent resource this case attaches to.
          enum:
            - filing
            - verification
            - business
            - session
        parent_id:
          type: string
          description: ID of the parent resource (filing_id, verification_id, etc.).
          example: fil_1a2b3c
        kind:
          type: string
          description: >-
            Typed kind of case. Each kind has its own request/response payload
            shape — see the request/response fields.
          enum:
            - missing_information
            - ra_termination
        status:
          type: string
          description: >-
            Lifecycle status. `needs_response` means the partner must act;
            `under_review` means Palm is working on it. Both are open states.
            `resolved` and `superseded` are terminal.
          enum:
            - needs_response
            - under_review
            - resolved
            - superseded
        summary:
          type: string
          description: One-line summary of the case.
          example: Additional information needed to complete your filing.
        details:
          type: string
          description: Markdown-formatted details about the case.
        request:
          description: >-
            Typed request payload — what Palm is asking for. Shape varies by
            kind.
          allOf:
            - $ref: '#/components/schemas/CaseRequestPayload'
        response:
          description: >-
            Typed response payload — what the partner submitted. Present once
            the partner has responded. Shape varies by kind.
          allOf:
            - $ref: '#/components/schemas/CaseResponsePayload'
        due_at:
          type: string
          description: Timestamp by which the case is expected to be resolved.
          format: date-time
        opened_at:
          type: string
          description: Timestamp the case was opened.
          format: date-time
        resolved_at:
          type: string
          description: Timestamp the case was resolved or superseded.
          format: date-time
        resolution_reason:
          type: string
          description: >-
            Why the case left an open state. Set when status is `resolved` or
            `superseded`.
          enum:
            - response_received
            - no_response_needed
            - parent_canceled
            - parent_completed
            - parent_failed
      required:
        - id
        - object
        - mode
        - created_at
        - updated_at
        - metadata
        - parent_type
        - parent_id
        - kind
        - status
        - summary
        - opened_at
    CaseRequestPayload:
      type: object
      properties:
        fields:
          description: 'Fields you''re being asked to supply (kind: missing_information).'
          type: array
          items:
            $ref: '#/components/schemas/FieldSpec'
    CaseResponsePayload:
      type: object
      properties:
        fields:
          type: object
          description: 'Map of field name to value (kind: missing_information).'
          additionalProperties: true
    FieldSpec:
      type: object
      properties:
        name:
          type: string
          description: >-
            Stable machine-readable identifier for the requested field. Used as
            the key in the response payload.
          example: corrected_legal_name
        type:
          type: string
          description: >-
            Primitive type of the requested value. One of: string, number,
            boolean, date.
          example: string
        description:
          type: string
          description: Human-readable prompt explaining what is being asked.
          example: >-
            Corrected legal name (state rejected "Acme LLC" — name already
            taken).
        required:
          type: boolean
          description: >-
            Whether this field must be present in the response. Defaults to
            true.
          example: true
        example:
          description: Example value to help you understand the expected format.
          oneOf:
            - type: string
            - type: number
            - type: boolean
          example: Acme Holdings LLC
      required:
        - name
        - type
        - description
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````