# List Incidents

Filters and returns Incident records for current Hub with basic info.

Endpoint: GET /hubs/{subdomain}/incidents
Version: 3.0-R1
Security: ApiKeyAuth

## Path parameters:

  - `subdomain` (string, required)
    Unique subdomain of requested Hub.

## Query parameters:

  - `created_by_me` (string)
    Behavior:
* true - filter events to only those which were created by
current user,
* false - filter events to only those which were not
created by current user,
* all - don't filter events by creator.
    Enum: "true", "false", "all"

  - `draft` (string)
    Filters events by presence of unpublished Incident Update:
* true - return only events containing at least one unpublished (draft)
Incident Update,
* false - return only events without any unpublished Incident Updates,
* all - return events without filtering by draft status.
    Enum: "true", "false", "all"

  - `incident_types` (string)
    Comma-separated names of incident types.
Filters incidents by status of last (including draft) update.
Examples:
  * incident_types=monitoring
  * incident_types=investigating,identified

Possible incident type values:
  * identified,
  * investigating,
  * monitoring,
  * resolved.

When not set, do not filter incidents by type of last update.

  - `published` (string)
    Filter events by status of publication on Hub Page:
* true - return only events published on Hub Page,
* false - return only events that were not published on Hub Page.
* all - don't filter events by publication status.
    Enum: "true", "false", "all"

  - `unconfirmed` (string)
    Filter events by state of the event:
* true - return only events were published as unconfirmed on Hub Page,
* false - return only events were published as confirmed on Hub Page.
* all - don't filter events by unconfirmed status.
    Enum: "true", "false", "all"

  - `archived` (string)
    Filters incidents by archived status:
* true - return only incidents that were archived,
* false - return only incidents that were not archived,
* all - return incidents without filtering by archived status.
    Enum: "true", "false", "all"

  - `deleted` (string)
    Filters incidents by deletion status:
* true - return only incidents that were deleted,
* false - return only incidents that were not deleted,
* all - return incidents without filtering by deleted status.
    Enum: "true", "false", "all"

  - `sort_prop` (string)
    Determines which property results should be sorted by.
    Enum: "created_at", "start_time", "updated_at"

  - `sort_dir` (string)
    Determines sorting direction.
    Enum: "asc", "desc"

  - `period_name` (string)
    Comma-separated period names.
Filters event by period name.

Examples:
  * period_name=current
  * period_name=past,current

Possible period name values:
  * past,
  * current.

When not set, do not filter by period.

  - `service_ids` (string)
    Comma-separated string of service ids.

Filters events by at least one affected service, specified in params.

Example: service_ids=1,2,3

  - `service_statuses` (string)
    Comma-separated string of service statuses names.

Filters events by at least one affected service with specified status.

Examples:
* service_statuses=degraded-performance
* service_statuses=up,down

Possible incident type values:
* up
* degraded-performance
* down

  - `start_time` (string)
    Lower limit of the event start time filter. ISO8601 formatted time (UTC).  Assumed as far in the past when not provided. Combined with end_time filter events to those which period of occurrence (from event start_time to event end_time with end_time being far in the future for open incidents) overlaps with start_time and end_time params.

  - `end_time` (string)
    Upper limit of the event end time filter. ISO8601 formatted time (UTC).  Assumed as far in the future when not provided. Combined with start_time filter events to those which period of occurrence (from event start_time to event end_time with end_time being far in the future for open incidents) overlaps with start_time and end_time params.

  - `q` (string)
    String that filters events to those containing the search string in:
- title,
- body.

  - `extend` (string)
    Specifies which properties should be expanded. Expanded properties contains more detailed information which is less frequently needed in typical usage. Currently supported only for flags.
    Example: "flags"

  - `page` (integer)
    Requested page index.

  - `per_page` (integer)
    A limit on the number of records to be returned.

  - `api_version` (string)
    Api version
    Enum: "V3-R1"

## Response 200 fields (application/json):

  - `current_page` (integer)
    Example: 1

  - `page_count` (integer)
    Example: 4

  - `per_page` (integer)
    Example: 25

  - `total` (integer)
    Example: 1024

  - `data` (array)

  - `data.id` (integer)
    Example: 13

  - `data.title` (string)
    Title of incident as visible on Hub Page. If there is draft IncidentUpdate that changes the title, the title will not reflect this change because the draft update is not published and therefore not visible on Hub Page.

  - `data.last_incident_type` (string)
    Type of Incident Update. Exact meaning may depend on use case and there is just one restriction: resolved can't be used as type of a first (by start_time) Incident Update.
    Enum: "investigating", "identified", "monitoring", "resolved"

  - `data.start_time` (string)
    Timestamp of the start_time of the first (by start_time) Incident Update. ISO8601 formatted time (UTC).
    Example: "2020-09-01T08:29:00Z"

  - `data.end_time` (string,null)
    Timestamp of event end. If not set it means that the event has not ended yet. ISO8601 formatted time (UTC).
    Example: "2020-09-01T08:29:00Z"

  - `data.flags` (any)