openapi: 3.0.0
info:
  title: Appealable Issues Appeals Status API
  version: v0
  contact:
    name: developer.va.gov
  description: "The Appealable Issues API lets you retrieve a list of a claimant’s appealable issues and any chains of preceding issues. Appealable issues are issues from claims about which VA has made a decision that may be eligible for appeal. Not all appealable issues are guaranteed to be eligible for appeal; for example, claimants may have another appeal in progress for an issue.\n\nTo check the status of all decision reviews and appeals for a specified individual, use the [Appeals Status API](https://developer.va.gov/explore/api/appeals-status/docs).\n\nTo file an appeal or decision review, use one of these APIs: \n* [Higher-Level Reviews API](https://developer.va.gov/explore/api/higher-level-reviews/docs)\n* [Notice of Disagreements API](https://developer.va.gov/explore/api/notice-of-disagreements/docs)\n* [Supplemental Claims API](https://developer.va.gov/explore/api/supplemental-claims/docs)\n\n## Technical overview\nThe Appealable Issues API pulls data from Caseflow, a case management system. It provides decision review and appeal data that can be used for submitting a Higher Level Review, Notice of Disagreement, or Supplemental Claim.\n\n### Authorization and Access\nThe authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported:\n* [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code)\n* [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials)\n\n**Important:** To get production access using client credentials grant, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).\n\n### Test data\n\nOur sandbox environment is populated with [Veteran test data](https://github.com/department-of-veterans-affairs/vets-api-clients/blob/master/test_accounts/appealable_issues_test_accounts.md) that can be used to test various response scenarios. This sandbox data contains no PII or PHI, but mimics real Veteran account information.\n"
servers:
- url: https://sandbox-api.va.gov/services/appeals/appealable-issues/{version}
  description: VA.gov API sandbox environment
  variables:
    version:
      default: v0
- url: https://api.va.gov/services/appeals/appealable-issues/{version}
  description: VA.gov API production environment
  variables:
    version:
      default: v0
tags:
- name: Appeals Status
  description: ''
paths:
  /appeals:
    get:
      summary: Retrieve appeals status for the Veteran with the supplied ICN
      tags:
      - Appeals Status
      operationId: getAppealStatus
      description: Returns a list of all known appeal records for the given Veteran. Includes details of each appeal's current status, priority, and history of updates.
      security:
      - productionOauth:
        - veteran/AppealsStatus.read
        - representative/AppealsStatus.read
        - system/AppealsStatus.read
      - sandboxOauth:
        - veteran/AppealsStatus.read
        - representative/AppealsStatus.read
        - system/AppealsStatus.read
      - bearer_token: []
      parameters:
      - name: icn
        description: Veteran's Master Person Index (MPI) Integration Control Number (ICN). Optional when using a veteran-scoped token. Required when using a representative- or system-scoped token.
        example: 1012832025V743496
        schema:
          type: string
          pattern: ^[0-9]{10}V[0-9]{6}$
          minLength: 17
          maxLength: 17
        in: query
        required: false
      responses:
        '200':
          description: Successfully fetching appeals
          content:
            application/json:
              examples:
                with a veteran-scoped token (no 'icn' parameter necessary):
                  value:
                    data:
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2002-09-23'
                          type: claim_decision
                        - date: '2003-01-06'
                          type: nod
                        - date: '2003-06-18'
                          type: soc
                        - date: '2003-09-30'
                          type: ftr
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: false
                          date: '2003-09-30'
                          description: Service connection, lumbosacral strain
                          diagnosticCode: '5295'
                          lastAction: withdrawn
                        location: bva
                        programArea: compensation
                        status:
                          details: {}
                          type: ftr
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '1196201'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: true
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2008-04-24'
                          type: claim_decision
                        - date: '2008-06-11'
                          type: nod
                        - date: '2010-09-10'
                          type: soc
                        - date: '2010-11-08'
                          type: form9
                        - date: '2014-01-03'
                          type: ssoc
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-04-17'
                          type: hearing_held
                        - date: '2015-07-24'
                          type: bva_decision
                        - date: '2015-10-06'
                          type: ssoc
                        - date: '2016-05-03'
                          type: bva_decision
                        - date: '2018-01-16'
                          type: ssoc
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, migraines
                          diagnosticCode: '8100'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, limitation of leg motion
                          diagnosticCode: '5260'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: 100% rating for individual unemployability
                          diagnosticCode: null
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, ankylosis of hip
                          diagnosticCode: '5250'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, hearing loss
                          diagnosticCode: '6100'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, sciatic nerve paralysis
                          diagnosticCode: '8520'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, arthritis due to trauma
                          diagnosticCode: '5010'
                          lastAction: null
                        - active: false
                          date: '2015-07-24'
                          description: New and material evidence for service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: allowed
                        location: aoj
                        programArea: compensation
                        status:
                          details: {}
                          type: remand_ssoc
                        type: post_remand
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '3294289'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: other
                        description: ''
                        docket: null
                        events:
                        - date: '2010-08-11'
                          type: claim_decision
                        - date: '2010-09-17'
                          type: nod
                        - date: '2013-09-26'
                          type: soc
                        - date: '2013-10-02'
                          type: form9
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-02-26'
                          type: merged
                        evidence: []
                        incompleteHistory: false
                        issues: []
                        location: bva
                        programArea: null
                        status:
                          details: {}
                          type: other_close
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '2348605'
                      type: legacyAppeal
                with a representative-scoped token ('icn' parameter is necessary):
                  value:
                    data:
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2002-09-23'
                          type: claim_decision
                        - date: '2003-01-06'
                          type: nod
                        - date: '2003-06-18'
                          type: soc
                        - date: '2003-09-30'
                          type: ftr
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: false
                          date: '2003-09-30'
                          description: Service connection, lumbosacral strain
                          diagnosticCode: '5295'
                          lastAction: withdrawn
                        location: bva
                        programArea: compensation
                        status:
                          details: {}
                          type: ftr
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '1196201'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: true
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2008-04-24'
                          type: claim_decision
                        - date: '2008-06-11'
                          type: nod
                        - date: '2010-09-10'
                          type: soc
                        - date: '2010-11-08'
                          type: form9
                        - date: '2014-01-03'
                          type: ssoc
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-04-17'
                          type: hearing_held
                        - date: '2015-07-24'
                          type: bva_decision
                        - date: '2015-10-06'
                          type: ssoc
                        - date: '2016-05-03'
                          type: bva_decision
                        - date: '2018-01-16'
                          type: ssoc
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, migraines
                          diagnosticCode: '8100'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, limitation of leg motion
                          diagnosticCode: '5260'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: 100% rating for individual unemployability
                          diagnosticCode: null
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, ankylosis of hip
                          diagnosticCode: '5250'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, hearing loss
                          diagnosticCode: '6100'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, sciatic nerve paralysis
                          diagnosticCode: '8520'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, arthritis due to trauma
                          diagnosticCode: '5010'
                          lastAction: null
                        - active: false
                          date: '2015-07-24'
                          description: New and material evidence for service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: allowed
                        location: aoj
                        programArea: compensation
                        status:
                          details: {}
                          type: remand_ssoc
                        type: post_remand
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '3294289'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: other
                        description: ''
                        docket: null
                        events:
                        - date: '2010-08-11'
                          type: claim_decision
                        - date: '2010-09-17'
                          type: nod
                        - date: '2013-09-26'
                          type: soc
                        - date: '2013-10-02'
                          type: form9
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-02-26'
                          type: merged
                        evidence: []
                        incompleteHistory: false
                        issues: []
                        location: bva
                        programArea: null
                        status:
                          details: {}
                          type: other_close
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '2348605'
                      type: legacyAppeal
                with a system-scoped token ('icn' parameter is necessary):
                  value:
                    data:
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2002-09-23'
                          type: claim_decision
                        - date: '2003-01-06'
                          type: nod
                        - date: '2003-06-18'
                          type: soc
                        - date: '2003-09-30'
                          type: ftr
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: false
                          date: '2003-09-30'
                          description: Service connection, lumbosacral strain
                          diagnosticCode: '5295'
                          lastAction: withdrawn
                        location: bva
                        programArea: compensation
                        status:
                          details: {}
                          type: ftr
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '1196201'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: true
                        alerts: []
                        aod: false
                        aoj: vba
                        description: ''
                        docket: null
                        events:
                        - date: '2008-04-24'
                          type: claim_decision
                        - date: '2008-06-11'
                          type: nod
                        - date: '2010-09-10'
                          type: soc
                        - date: '2010-11-08'
                          type: form9
                        - date: '2014-01-03'
                          type: ssoc
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-04-17'
                          type: hearing_held
                        - date: '2015-07-24'
                          type: bva_decision
                        - date: '2015-10-06'
                          type: ssoc
                        - date: '2016-05-03'
                          type: bva_decision
                        - date: '2018-01-16'
                          type: ssoc
                        evidence: []
                        incompleteHistory: false
                        issues:
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, migraines
                          diagnosticCode: '8100'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: Increased rating, limitation of leg motion
                          diagnosticCode: '5260'
                          lastAction: remand
                        - active: true
                          date: '2016-05-03'
                          description: 100% rating for individual unemployability
                          diagnosticCode: null
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, ankylosis of hip
                          diagnosticCode: '5250'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, hearing loss
                          diagnosticCode: '6100'
                          lastAction: null
                        - active: true
                          date: '2015-07-24'
                          description: Service connection, sciatic nerve paralysis
                          diagnosticCode: '8520'
                          lastAction: remand
                        - active: false
                          date: null
                          description: Service connection, arthritis due to trauma
                          diagnosticCode: '5010'
                          lastAction: null
                        - active: false
                          date: '2015-07-24'
                          description: New and material evidence for service connection, degenerative spinal arthritis
                          diagnosticCode: '5242'
                          lastAction: allowed
                        location: aoj
                        programArea: compensation
                        status:
                          details: {}
                          type: remand_ssoc
                        type: post_remand
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '3294289'
                      type: legacyAppeal
                    - attributes:
                        appealIds: []
                        active: false
                        alerts: []
                        aod: false
                        aoj: other
                        description: ''
                        docket: null
                        events:
                        - date: '2010-08-11'
                          type: claim_decision
                        - date: '2010-09-17'
                          type: nod
                        - date: '2013-09-26'
                          type: soc
                        - date: '2013-10-02'
                          type: form9
                        - date: '2014-07-28'
                          type: certified
                        - date: '2015-02-26'
                          type: merged
                        evidence: []
                        incompleteHistory: false
                        issues: []
                        location: bva
                        programArea: null
                        status:
                          details: {}
                          type: other_close
                        type: original
                        updated: '2018-01-19T10:20:42-05:00'
                      id: '2348605'
                      type: legacyAppeal
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/appeals'
                required:
                - data
        '400':
          description: Missing parameters
          content:
            application/json:
              examples:
                with a representative-scoped token and no 'icn' parameter:
                  value:
                    errors:
                    - title: Missing parameter
                      detail: The 'icn' parameter is required with this request
                      code: '108'
                      status: '400'
                with a system-scoped token and no 'icn' parameter:
                  value:
                    errors:
                    - title: Missing parameter
                      detail: The 'icn' parameter is required with this request
                      code: '108'
                      status: '400'
              schema:
                $ref: '#/components/schemas/errorModel'
        '403':
          description: Forbidden requests
          content:
            application/json:
              examples:
                with a veteran-scoped token and an optional 'icn' parameter that does not match the Veteran's ICN:
                  value:
                    errors:
                    - title: Forbidden
                      detail: 'Invalid ''icn'' parameter: Veterans may access only their own records'
                      code: '403'
                      status: '403'
              schema:
                $ref: '#/components/schemas/errorModel'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                Not Found:
                  value:
                    errors:
                    - title: Resource not found
                      detail: A matching Veteran was not found in our systems
                      code: '404'
                      status: '404'
              schema:
                $ref: '#/components/schemas/errorModel'
        '422':
          description: Invalid 'icn' parameter
          content:
            application/json:
              examples:
                with an incorrectly formatted 'icn' parameter:
                  value:
                    errors:
                    - title: Unprocessable Entity
                      detail: '''icn'' parameter has an invalid format. Pattern: /^[0-9]{10}V[0-9]{6}$/'
                      code: '422'
                      status: '422'
              schema:
                $ref: '#/components/schemas/errorModel'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                errors:
                - title: Internal server error
                  detail: Internal server error
                  code: '500'
                  status: '500'
              schema:
                $ref: '#/components/schemas/errorModel'
components:
  schemas:
    event:
      type: object
      description: Event during the appeals process
      properties:
        type:
          type: string
          example: soc
          description: Enum of possible event types. Acronyms used include, nod (Notice of Disagreement), soc (Statement of Case), ssoc (Supplemental Statement of Case), ftr (Failed to Report), bva (Board of Veteran Appeals), cavc (Court of Appeals for Veteran Claims), and dro (Decision Review Officer).
          enum:
          - claim_decision
          - nod
          - soc
          - form9
          - ssoc
          - certified
          - hearing_held
          - hearing_no_show
          - bva_decision
          - field_grant
          - withdrawn
          - ftr
          - ramp
          - death
          - merged
          - record_designation
          - reconsideration
          - vacated
          - other_close
          - cavc_decision
          - ramp_notice
          - transcript
          - remand_return
          - ama_nod
          - docket_change
          - distributed_to_vlj
          - bva_decision_effectuation
          - dta_decision
          - sc_request
          - sc_decision
          - sc_other_close
          - hlr_request
          - hlr_decision
          - hlr_dta_error
          - hlr_other_close
          - statutory_opt_in
        date:
          type: string
          format: date
          description: Date the event occurred
          example: '2016-05-30'
        details:
          description: Further information about the event
          type: object
    evidence:
      type: object
      description: Documentation and other evidence that has been submitted in support of the appeal
      properties:
        description:
          type: string
          example: Service treatment records
          description: Short text describing what the evidence is
        date:
          type: string
          format: date
          description: Date the evidence was added to the case
          example: '2017-09-30'
    errorModel:
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            additionalProperties: false
            required:
            - title
            properties:
              title:
                type: string
                description: HTTP error title
              detail:
                type: string
                description: HTTP error detail
              code:
                type: string
                description: HTTP error code
              source:
                type: object
                additionalProperties: false
                description: Source of error
                properties:
                  pointer:
                    type: string
                    description: Pointer to source of error
                  parameter:
                    type: string
                    description: Invalid request parameter
                  header:
                    type: string
                    description: Invalid header
              status:
                type: string
                description: HTTP error code
              meta:
                type: object
                description: Meta infomation
                properties:
                  missing_fields:
                    type: array
                    items:
                      type: string
                    description: List of missing fields
    issue:
      type: object
      description: Issues on appeal
      properties:
        active:
          type: boolean
          example: true
          description: Whether the issue is presently under contention.
        description:
          type: string
          example: Service connection, tinnitus
          description: Description of the Issue
        diagnosticCode:
          nullable: true
          type: string
          example: '6260'
          description: The CFR (Code of Federal Regulations) diagnostic code for the issue, if applicable
        lastAction:
          nullable: true
          type: string
          description: Most recent decision made on this issue
          enum:
          - field_grant
          - withdrawn
          - allowed
          - denied
          - remand
          - cavc_remand
        date:
          anyOf:
          - nullable: true
            type: string
            format: date
            description: The date of the most recent decision on the issue
            example: '2016-05-30'
    appeal:
      type: object
      properties:
        id:
          type: string
          description: ID from VACOLS (Veteran Appeals Control and Locator Service) or Caseflow
          example: '7387389'
        type:
          type: string
          description: The decision review option chosen by the appellant
          example: legacyAppeal
          enum:
          - legacyAppeal
          - appeal
          - supplementalClaim
          - higherLevelReview
        attributes:
          type: object
          properties:
            appealIds:
              type: array
              description: An array of the individual IDs that are combined into this appeal
              items:
                type: string
                example: '1234567'
            updated:
              type: string
              format: date-time
              example: '2018-01-03T09:30:15-05:00'
              description: The timestamp for the last refresh of the data
            active:
              type: boolean
              description: Indicates whether the appeal is ongoing or closed
              example: true
            incompleteHistory:
              type: boolean
              example: false
              description: Indicates whether this response contains a complete history of this appeal
            aoj:
              type: string
              description: Agency of Original Jurisdiction, vba is Veterans Benefits Administration, vha is Veterans Health Administration, and nca is National Cemetery Administration.
              example: vba
              enum:
              - vba
              - vha
              - nca
              - other
            programArea:
              nullable: true
              type: string
              example: pension
              enum:
              - compensation
              - pension
              - insurance
              - loan_guaranty
              - education
              - vre
              - medical
              - burial
              - bva
              - fiduciary
              - other
              - multiple
            description:
              type: string
              description: Description of the appeal
              example: Service connection, tinnitus, and 3 others
            type:
              type: string
              description: Indicates the type of Appeal. CAVC is the Court of Appeals for Veterans Claims
              enum:
              - original
              - post_remand
              - post_cavc_remand
              - reconsideration
              - cue
            aod:
              type: boolean
              example: false
              description: Advanced on Docket, whether this appeal was prioritized due to Veteran age or urgency.
            location:
              type: string
              example: bva
              description: Indicates who currently has the appeal AOJ (Agency of Original Jurisdiction) or BVA (Board of Veterans Appeals)
              enum:
              - aoj
              - bva
            status:
              type: object
              description: This appeal's position in the appeal process
              properties:
                type:
                  type: string
                  description: Indicates the current position in the appeal process
                  enum:
                  - scheduled_hearing
                  - pending_hearing_scheduling
                  - on_docket
                  - pending_certification_ssoc
                  - pending_certification
                  - pending_form9
                  - pending_soc
                  - stayed
                  - at_vso
                  - bva_development
                  - decision_in_progress
                  - bva_decision
                  - field_grant
                  - withdrawn
                  - ftr
                  - ramp
                  - death
                  - reconsideration
                  - other_close
                  - remand_ssoc
                  - remand
                  - merged
                  - evidentiary_period
                  - ama_remand
                  - post_bva_dta_decision
                  - bva_decision_effectuation
                  - sc_received
                  - sc_decision
                  - sc_closed
                  - hlr_received
                  - hlr_dta_error
                  - hlr_decision
                  - hlr_closed
                  - statutory_opt_in
                details:
                  type: object
                  description: Further information about appeal's timeline
                  properties:
                    lastSocDate:
                      type: string
                      example: '2018-05-15'
                      description: the date of the last SOC (statement of case) or SSOC (supplemental statement of case)
                    certificationTimeliness:
                      type: array
                      example:
                      - 2
                      - 12
                      items:
                        type: integer
                      description: the range of months it typically takes to certify an appeal
                    ssocTimeliness:
                      type: array
                      example:
                      - 7
                      - 20
                      items:
                        type: integer
                      description: the range of months it typically takes to create an SSOC (supplemental statement of case)
                    decisionTimeliness:
                      type: array
                      example:
                      - 1
                      - 2
                      items:
                        type: integer
                      description: the range of months it typically takes to mail a decision after the appeal has been first assigned to an attorney
                    remandTimeliness:
                      type: array
                      example:
                      - 16
                      - 29
                      items:
                        type: integer
                      description: the range of months it typically takes to either create an SSOC (supplemental statement of case), field grant, or return to the Board a remand
                    socTimeliness:
                      type: array
                      example:
                      - 10
                      - 16
                      items:
                        type: integer
                      description: the range of months it typically takes to create an SOC (statement of case) or field grant
                    remandSsocTimeliness:
                      type: array
                      example:
                      - 3
                      - 11
                      items:
                        type: integer
                      description: the range of months it typically takes to create a second SSOC (supplemental statement of case) on a remand
                    returnTimeliness:
                      type: array
                      example:
                      - 1
                      - 2
                      items:
                        type: integer
                      description: the range of months it typically takes to return a remand to the Board after creating an SSOC (supplemental statement of case)
            docket:
              nullable: true
              type: object
              description: Represents the appeals' position in line for a decision and the expected timing of the decision
              properties:
                type:
                  type: string
                  description: Indicates the docket of the appeal
                  enum:
                  - directReview
                  - evidenceSubmission
                  - hearingRequest
                  - legacy
                  example: hearingRequest
                month:
                  type: string
                  format: date
                  example: '2016-08-01'
                docketMonth:
                  type: string
                  format: date
                  example: '2014-06-01'
                front:
                  type: boolean
                  example: false
                total:
                  type: integer
                  example: 206900
                totalAllDockets:
                  type: integer
                  example: 420012
                ahead:
                  type: integer
                  example: 109203
                ready:
                  type: integer
                  example: 22109
                eta:
                  $ref: '#/components/schemas/eta'
                eligibleToSwitch:
                  type: boolean
                  example: true
                switchDueDate:
                  type: string
                  format: date
                  example: '2020-06-01'
            issues:
              type: array
              items:
                $ref: '#/components/schemas/issue'
            alerts:
              type: array
              items:
                $ref: '#/components/schemas/alert'
            events:
              type: array
              items:
                $ref: '#/components/schemas/event'
            evidence:
              type: array
              items:
                $ref: '#/components/schemas/evidence'
    alert:
      type: object
      description: Notification of a request for more information or of a change in the appeal status that requires action.
      properties:
        type:
          type: string
          description: Enum of notifications for an appeal. Acronyms used include cavc (Court of Appeals for Veteran Claims), vso (Veteran Service Organization), and dro (Decision Review Officer).
          example: form9_needed
          enum:
          - form9_needed
          - scheduled_hearing
          - hearing_no_show
          - held_for_evidence
          - cavc_option
          - ramp_eligible
          - ramp_ineligible
          - decision_soon
          - blocked_by_vso
          - scheduled_dro_hearing
          - dro_hearing_no_show
          - evidentiary_period
          - ama_post_decision
        details:
          description: Further information about the alert
          type: object
    eta:
      type: object
      description: Estimated decision dates for each docket.
      properties:
        directReview:
          format: date
          example: '2020-02-01'
        evidenceSubmission:
          format: date
          example: '2024-06-01'
        hearing:
          format: date
          example: '2024-06-01'
    appeals:
      type: array
      items:
        $ref: '#/components/schemas/appeal'
  securitySchemes:
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
    productionOauth:
      type: oauth2
      description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).'
      flows:
        authorizationCode:
          authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
          tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
          scopes:
            veteran/AppealableIssues.read: Appealable issues info
            veteran/appeals.read: Appeals info
            representative/AppealableIssues.read: Appealable issues info
            representative/appeals.read: Appeals info
        clientCredentials:
          tokenUrl: To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
          scopes:
            system/AppealableIssues.read: Appealable issues info
            system/appeals.read: Appeals info
    sandboxOauth:
      type: oauth2
      description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).'
      flows:
        authorizationCode:
          authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
          tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
          scopes:
            veteran/AppealableIssues.read: Appealable issues info
            veteran/appeals.read: Appeals info
            representative/AppealableIssues.read: Appealable issues info
            representative/appeals.read: Appeals info
        clientCredentials:
          tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
          scopes:
            system/AppealableIssues.read: Appealable issues info
            system/appeals.read: Appeals info