API Reference
API Reference

List Incidents

List service incidents with pagination and filtering

GET/api/v1/incidents/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required

Names of agent fields supported for filtering/sorting on list endpoint.

Allowed values ["id","description","impact_category","sessions_impacted","markdown","created_at","updated_at","organization_id","sub_organization_id","start_datetime","end_datetime","resolution_datetime"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["id","description","impact_category","sessions_impacted","markdown","created_at","updated_at","organization_id","sub_organization_id","start_datetime","end_datetime","resolution_datetime"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required

Names of agent fields supported for filtering/sorting on list endpoint.

Allowed values ["id","description","impact_category","sessions_impacted","markdown","created_at","updated_at","organization_id","sub_organization_id","start_datetime","end_datetime","resolution_datetime"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_IncidentResponse_ required
5 fields
itemsIncidentResponse[]required

List of items returned from the query

Item schema
itemsIncidentResponserequired

Response model for service incident operations.

13 fields
descriptionstringrequired

Description of the service incident

start_datetimestring (date-time)required

Start time of the incident

resolution_datetimestring (date-time)required

Resolution time of the incident

impact_categorystringrequired

Category of the impact

sessions_impactedintegerrequired

Number of sessions impacted

markdownstringrequired

Detailed markdown description of the incident

organization_idinteger | nulloptional

The ID of the organization

sub_organization_idinteger | nulloptional

The ID of the sub-organization

sub_organizationstring | nulloptional

The name of the sub-organization (DEPRECATED)

idintegerrequired

The ID of the incident to update

created_atstring (date-time) | nulloptional

Creation time of the incident

updated_atstring (date-time) | nulloptional

Last update time of the incident

last_updated_bystring | nullrequired

The email of the user who last updated the incident

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "description": "string",
      "start_datetime": "string",
      "resolution_datetime": "string",
      "impact_category": "string",
      "sessions_impacted": 0,
      "markdown": "string",
      "organization_id": "string",
      "sub_organization_id": "string",
      "sub_organization": "string",
      "id": 0,
      "created_at": "string",
      "updated_at": "string",
      "last_updated_by": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}