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

# View a case

> Returns a simple snapshot of a case the user can access.



## OpenAPI

````yaml /api-reference/api.yaml post /cases/view
openapi: 3.0.3
info:
  title: api
  description: >-
    The API service is the secure public gateway to our platform, letting people
    access features without touching our private internal APIs. It authenticates
    clients with its own internal tokens and then routes their requests to the
    right internal services behind the scenes.
  version: 1.0.0
servers:
  - url: https://api.platform.arb.inc
security: []
tags:
  - name: cases
  - name: docket
  - name: evidence
  - name: filings
  - name: organization
  - name: participants
  - name: schemas
  - name: service-of-notice
paths:
  /cases/view:
    post:
      tags:
        - cases
      summary: View a case
      description: Returns a simple snapshot of a case the user can access.
      operationId: postCasesView
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - caseID
              properties:
                caseID:
                  type: string
                  description: The identifier of the case to view.
                  example: 2025-08-00139
      responses:
        '200':
          description: Case overview, participants, and timetable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  overview:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Unique identifier for the case.
                        example: 2025-08-00139
                      created:
                        type: string
                        format: date-time
                        description: When the case was created.
                        example: '2025-08-23T02:47:42Z'
                      updated:
                        type: string
                        format: date-time
                        description: When the case was last updated.
                        example: '2025-08-23T02:47:42Z'
                      createdByUserID:
                        type: string
                        description: ID of the user who created the case.
                        example: 00c573fd-18d9-4fbe-921e-6926d2c4869e
                      createdByOrgID:
                        type: string
                        nullable: true
                        description: ID of the organization that created the case, if any.
                        example: null
                      phaseID:
                        type: string
                        description: Current phase identifier.
                        example: caseInitiation
                      title:
                        type: string
                        description: Human-friendly title for the case.
                        example: Case 2025-08-00139
                      claimantName:
                        type: string
                        nullable: true
                        description: Name of the claimant (may be null).
                        example: Acme Inc
                      respondentName:
                        type: string
                        nullable: true
                        description: Name of the respondent (may be null).
                        example: Mike Smith
                      canSubmitEvidence:
                        type: boolean
                        description: Whether parties can currently submit evidence.
                        example: true
                      isCaseClosed:
                        type: boolean
                        description: Whether the case is closed or active.
                        example: false
                  participants:
                    type: array
                    description: List of case participants.
                    items:
                      type: object
                      properties:
                        created:
                          type: string
                          format: date-time
                          description: When the participant was added.
                          example: '2025-08-23T02:47:42Z'
                        userID:
                          type: string
                          description: ID of the participant user.
                          example: 00c573fd-18d9-4fbe-921e-6926d2c4869e
                        organizationID:
                          type: string
                          nullable: true
                          description: Organization ID of the participant, if any.
                          example: null
                        firstName:
                          type: string
                          description: Participants first name.
                          example: Owen
                        lastName:
                          type: string
                          nullable: true
                          description: Optional participants last name.
                          example: Smith
                        partyID:
                          type: string
                          description: Role of the participant.
                          example: claimant
                        isPrimary:
                          type: boolean
                          description: >-
                            Whether the participant is the primary
                            representative.
                          example: true
                        isObserver:
                          type: boolean
                          description: Whether the participant is an observer.
                          example: false
                  partyID:
                    type: string
                    description: Users party in the case.
                    example: claimant
                  timetable:
                    type: object
                    description: Case timetable details.
                    properties:
                      phases:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Phase identifier.
                              example: caseInitiation
                            scheduledStart:
                              type: string
                              format: date-time
                              description: Scheduled start of the phase.
                              example: '2025-08-23T02:47:42.123816Z'
                            scheduledEnd:
                              type: string
                              format: date-time
                              nullable: true
                              description: Scheduled end of the phase, if set.
                              example: null
                            filingDeadline:
                              type: string
                              format: date-time
                              description: Deadline for required filings in this phase.
                              example: '2025-09-23T02:47:42.123816Z'
                            documents:
                              type: array
                              description: Documents relevant to this phase.
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    description: Document identifier.
                                    example: statementOfClaim
                                  filedBy:
                                    type: string
                                    nullable: true
                                    description: Party who files the document.
                                    example: claimant
                                  approvedBy:
                                    type: string
                                    nullable: true
                                    description: Party who approves the document, if any.
                                    example: caseManager
                                  maxAllowed:
                                    type: integer
                                    description: Maximum number of documents allowed.
                                    example: 1
                                  required:
                                    type: boolean
                                    description: Whether the document is required.
                                    example: true
                  settlement:
                    type: object
                    description: >-
                      (Optional) Contact details for settlement-related
                      communication.
                    properties:
                      phone:
                        type: string
                        description: >-
                          (Optional) Contact phone number for settlement-related
                          communication.
                        example: '+15555555555'
                      email:
                        type: string
                        format: email
                        description: >-
                          (Optional) Contact email address for
                          settlement-related communication.
                        example: settle@example.com
                      website:
                        type: string
                        format: uri
                        description: >-
                          (Optional) Website or portal link for settlement
                          information.
                        example: https://example.com?ref=12345
                      amount:
                        type: string
                        description: >-
                          (Optional) Total amount the claimant believes the
                          respondent owes.
                        example: $1000.00
                      offer:
                        type: string
                        description: >-
                          (Optional) Settlement amount the claimant is willing
                          to accept right now.
                        example: $750
                      validForDays:
                        type: integer
                        description: >-
                          (Optional) Number of days the settlement offer will
                          remain valid.
                        example: 7
                example:
                  overview:
                    id: 2025-08-00139
                    created: '2025-08-23T02:47:42Z'
                    updated: '2025-08-23T02:47:42Z'
                    createdByUserID: 00c573fd-18d9-4fbe-921e-6926d2c4869e
                    createdByOrgID: null
                    phaseID: caseInitiation
                    title: Case 2025-08-00139
                    claimantName: Acme Inc
                    respondentName: Mike Smith
                    canSubmitEvidence: true
                  participants:
                    - created: '2025-08-23T02:47:42Z'
                      userID: 00c573fd-18d9-4fbe-921e-6926d2c4869e
                      organizationID: null
                      firstName: Owen
                      lastName: Smith
                      partyID: claimant
                      isPrimary: true
                      isObserver: false
                    - created: '2025-08-23T02:48:01Z'
                      userID: df25d20f-8042-44e2-97af-3609659c56a3
                      firstName: Kyle
                      lastName: Taskman
                      organizationID: null
                      partyID: caseManager
                      isPrimary: true
                      isObserver: false
                  partyID: claimant
                  timetable:
                    phases:
                      - id: caseInitiation
                        scheduledStart: '2025-08-23T02:47:42.123816Z'
                        scheduledEnd: null
                        filingDeadline: '2025-09-23T02:47:42.123816Z'
                        documents:
                          - id: statementOfClaim
                            filedBy: claimant
                            approvedBy: caseManager
                            maxAllowed: 1
                            required: true
                          - id: noticeOfArbitration
                            filedBy: caseManager
                            approvedBy: null
                            maxAllowed: 1
                            required: true
                  settlement:
                    type: object
                    description: >-
                      (Optional) Settlement details, including contact and
                      financial terms.
                    properties:
                      phone:
                        type: string
                        description: >-
                          (Optional) Contact phone number for settlement-related
                          communication.
                        example: '+15555555555'
                      email:
                        type: string
                        format: email
                        description: >-
                          (Optional) Contact email address for
                          settlement-related communication.
                        example: settle@example.com
                      website:
                        type: string
                        format: uri
                        description: >-
                          (Optional) Website or portal link for settlement
                          information.
                        example: https://example.com?ref=12345
                      amount:
                        type: string
                        description: >-
                          (Optional) Total amount the claimant believes the
                          respondent owes.
                        example: $1000.00
                      offer:
                        type: string
                        description: >-
                          (Optional) Settlement amount the claimant is willing
                          to accept right now.
                        example: $750
                      validForDays:
                        type: integer
                        description: >-
                          (Optional) Number of days the settlement offer will
                          remain valid.
                        example: 7
        '404':
          description: The case was not found.
          content:
            text/plain:
              schema:
                type: string
                example: case not found
        '410':
          description: The user is not a participant in the case.
          content:
            text/plain:
              schema:
                type: string
                example: user is not a participant
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: access token
      scheme: bearer
      bearerFormat: JWT

````