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

# List Incidents



## OpenAPI

````yaml api-reference/openapi.json get /incidents
openapi: 3.1.0
info:
  title: Cachet
  version: 0.0.1
  description: >-
    API documentation for Cachet, the open-source, self-hosted status page
    system.
servers:
  - url: http://localhost/api
  - url: https://v3.cachethq.io/api
    description: The Cachet v3 demo server.
security:
  - http: []
tags:
  - name: Cachet
  - name: Components
  - name: Component Groups
  - name: Incidents
  - name: Incident Updates
  - name: Incident Templates
  - name: Metrics
  - name: Metric Points
  - name: Schedules
  - name: Schedule Updates
paths:
  /incidents:
    get:
      tags:
        - Incidents
      summary: List Incidents
      operationId: cachet.api.incidents.index
      parameters:
        - name: sort
          in: query
          description: >-
            Available sorts are `name`, `status`, `id`. You can sort by multiple
            options by separating them with a comma. To sort in descending
            order, use `-` sign in front of the sort, for example: `-name`.
          schema:
            type: string
        - name: include
          in: query
          description: >-
            Available includes are `components`, `componentsCount`,
            `componentsExists`, `updates`, `updatesCount`, `updatesExists`,
            `user`, `userCount`, `userExists`. You can include multiple options
            by separating them with a comma.
          schema:
            type: string
        - name: per_page
          in: query
          description: How many items to show per page.
          schema:
            type: integer
            default: 15
          example: 20
        - name: page
          in: query
          description: Which page to show.
          schema:
            type: integer
          example: 2
        - name: filter[name]
          in: query
          schema:
            type: string
        - name: filter[status]
          in: query
          schema:
            type: string
        - name: filter[occurred_at]
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Paginated set of `Incident`
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Incident'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                      last:
                        type: string
                      prev:
                        type: string
                      next:
                        type: string
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      from:
                        type:
                          - integer
                          - 'null'
                      path:
                        type:
                          - string
                          - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                      to:
                        type:
                          - integer
                          - 'null'
                        description: Number of the last item in the slice.
                    required:
                      - current_page
                      - from
                      - path
                      - per_page
                      - to
                  included:
                    type: array
                    items:
                      anyOf:
                        - $ref: '#/components/schemas/Component'
                        - $ref: '#/components/schemas/Update'
                        - $ref: '#/components/schemas/User'
                required:
                  - data
                  - links
                  - meta
      security: []
components:
  schemas:
    Incident:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - incidents
        attributes:
          type: object
          properties:
            id:
              type: integer
            guid:
              type: string
            name:
              type: string
            message:
              type: string
            visible:
              $ref: '#/components/schemas/ResourceVisibilityEnum'
            stickied:
              type: boolean
            notifications:
              type: integer
            components_count:
              type: string
            status:
              type: object
              properties:
                human:
                  type: string
                value:
                  type: string
              required:
                - human
                - value
            occurred:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
            created:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
            updated:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
          required:
            - id
            - guid
            - name
            - message
            - visible
            - stickied
            - notifications
            - status
            - occurred
            - created
            - updated
        relationships:
          type: object
          properties:
            components:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/ComponentIdentifier'
              required:
                - data
            updates:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/UpdateIdentifier'
              required:
                - data
            user:
              type: object
              properties:
                data:
                  anyOf:
                    - $ref: '#/components/schemas/UserIdentifier'
                    - type: 'null'
              required:
                - data
      required:
        - id
        - type
      title: Incident
    Component:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - components
        attributes:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            description:
              type:
                - string
                - 'null'
            link:
              type:
                - string
                - 'null'
            order:
              type:
                - integer
                - 'null'
            status:
              type: object
              properties:
                human:
                  type: string
                value:
                  type: string
              required:
                - human
                - value
            enabled:
              type: boolean
            meta:
              type:
                - array
                - 'null'
              items: {}
            created:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
            updated:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
            pivot:
              type: object
              properties:
                component_status:
                  type: object
                  properties:
                    human:
                      type: string
                    value:
                      type: string
                  required:
                    - human
                    - value
              required:
                - component_status
          required:
            - id
            - name
            - description
            - link
            - order
            - status
            - enabled
            - meta
            - created
            - updated
        relationships:
          type: object
          properties:
            group:
              type: object
              properties:
                data:
                  anyOf:
                    - $ref: '#/components/schemas/ComponentGroupIdentifier'
                    - type: 'null'
              required:
                - data
            incidents:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/IncidentIdentifier'
              required:
                - data
      required:
        - id
        - type
      title: Component
    Update:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - updates
        attributes:
          type: object
          properties:
            id:
              type: integer
            updateable_id:
              type: integer
            updateable_type:
              type: string
            message:
              type: string
            status:
              type: object
              properties:
                human:
                  type: string
                value:
                  type: string
              required:
                - human
                - value
            created:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
            updated:
              type: object
              properties:
                human:
                  type: string
                string:
                  type: string
              required:
                - human
                - string
          required:
            - id
            - updateable_id
            - updateable_type
            - message
            - created
            - updated
      required:
        - id
        - type
      title: Update
    User:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
          required:
            - id
      required:
        - id
        - type
      title: User
    ResourceVisibilityEnum:
      type: integer
      enum:
        - 0
        - 1
        - 2
      title: ResourceVisibilityEnum
    ComponentIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - components
        id:
          type: string
      required:
        - type
        - id
      title: ComponentIdentifier
    UpdateIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - updates
        id:
          type: string
      required:
        - type
        - id
      title: UpdateIdentifier
    UserIdentifier:
      type: object
      properties:
        type:
          type: string
        id:
          type: string
      required:
        - type
        - id
      title: UserIdentifier
    ComponentGroupIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - componentGroups
        id:
          type: string
      required:
        - type
        - id
      title: ComponentGroupIdentifier
    IncidentIdentifier:
      type: object
      properties:
        type:
          type: string
          enum:
            - incidents
        id:
          type: string
      required:
        - type
        - id
      title: IncidentIdentifier
  securitySchemes:
    http:
      type: http
      scheme: bearer

````