External DocumentationTo learn more, visit the FireHydrant documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| End Date | Only include incidents that start on or before this date. |
| Environments | A comma-separated list of environment IDs to filter incidents by. |
| Name | Filter incidents by their name. |
| Page | The page number to show results from. |
| Per Page | Maximum number of results to return. |
| Query | Filter incidents by their name, summary and description. |
| Start Date | Only include incidents that started on or after this date. |
| Status | Filter by the status of the incident. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Archived | Select to return archived incidents. |
| Assigned Teams | A comma-separated list of IDs for assigned teams to filter incidents by. |
| Closed At Or After | Include incidents that were closed at or after this time. |
| Closed At Or Before | Include incidents that were closed at or before this time. |
| Conditions | A JSON string that defines logic and user_data. |
| Created At Or After | Include incidents that were created at or after this time. |
| Created At Or Before | Include incidents that were created at or before this time. |
| Current Milestones | A comma-separated list of current milestones to filter incidents by. |
| Excluded Infrastructure IDs | A comma-separated list of infrastructure IDs to exclude from the response. |
| Functionalities | A comma-separated list of functionality IDs to filter incidents by. |
| Incident Type IDs | A comma-separated list of incident type IDs to filter incidents by. |
| Priorities | A comma-separated list of priorities to filter incidents by. |
| Priority Not Set | Select to exclude incidents where priority has not been set. |
| Resolved At Or After | Include incidents that were resolved at or after this time. |
| Resolved At Or Before | Include incidents that were resolved at or before this time. |
| Retrospective Templates | A comma-separated list of retrospective template IDs to filter incidents by. |
| Saved Search ID | Filter by the ID of a previously saved search. |
| Services | A comma-separated list of service IDs to filter incidents by. |
| Severities | A comma-separated list of severities to filter incidents by. |
| Severity Not Set | Select to exclude incidents where severity has not been set. |
| Tag Match Strategy | Define how tags should be matched when filtering alerts. - any: Return alerts that contain at least one of the specified tags.- match_all: Return alerts that contain all of the specified tags.- exclude: Return alerts that contain none of the specified tags.have none of the supplied tags. |
| Tags | A comma-separated list of tags to filter incidents by. |
| Teams | A comma-separated list of team IDs to filter by. Can be obtained by using the List Teams action. |
| Updated After | Include incidents that were updated after this date. |
| Updated Before | Include incidents that were updated before this date. |
Example Output
{
"data": [
{
"id": "string",
"name": "string",
"created_at": "2025-07-16T09:20:11.089Z",
"started_at": "2025-07-16T09:20:11.089Z",
"discarded_at": "2025-07-16T09:20:11.089Z",
"summary": "string",
"customer_impact_summary": "string",
"description": "string",
"current_milestone": "string",
"number": 0,
"priority": "string",
"severity": "string",
"severity_color": "string",
"severity_impact": "string",
"severity_condition": "string",
"tag_list": [
"string"
],
"incident_type": {
"id": "string",
"name": "string"
},
"severity_impact_object": {
"id": "string",
"name": "string",
"type": "string",
"affects_id": "string",
"position": 0
},
"severity_condition_object": {
"id": "string",
"name": "string",
"position": 0
},
"private_id": "string",
"organization_id": "string",
"milestones": [
{
"id": "string",
"type": "string",
"duration": "string",
"occurred_at": "2025-07-16T09:20:11.089Z",
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z"
}
],
"lifecycle_phases": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"position": 0,
"milestones": [
{
"id": "string",
"name": "string",
"description": "string",
"slug": "string",
"position": 0,
"occurred_at": "2025-07-16T09:20:11.089Z",
"duration": "string",
"updated_by": {
"id": "string",
"name": "string",
"source": "string",
"email": "string"
},
"updated_at": "2025-07-16T09:20:11.089Z"
}
]
}
],
"lifecycle_measurements": [
{
"id": "string",
"name": "string",
"description": "string",
"slug": "string",
"starts_at_milestone": "string",
"ends_at_milestone": "string",
"value": "string",
"calculated_at": "2025-07-16T09:20:11.089Z"
}
],
"active": true,
"labels": {},
"role_assignments": [
{
"id": "string",
"status": "active",
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"incident_role": {
"id": "string",
"name": "string",
"summary": "string",
"description": "string",
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"discarded_at": "2025-07-16T09:20:11.089Z"
},
"user": {
"id": "string",
"name": "string",
"email": "string",
"slack_user_id": "string",
"slack_linked?": true,
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"signals_enabled_notification_types": [
"string"
]
}
}
],
"status_pages": [
{
"id": "string",
"url": "string",
"external_id": "string",
"name": "string",
"display_name": "string",
"integration": {
"id": "string",
"integration_name": "string",
"integration_slug": "string",
"display_name": "string",
"created_at": "2025-07-16T09:20:11.089Z"
}
}
],
"incident_url": "string",
"private_status_page_url": "string",
"organization": {
"name": "string",
"id": "string"
},
"customers_impacted": 0,
"monetary_impact": 0,
"monetary_impact_cents": 0,
"last_update": "string",
"last_note": {
"id": "string",
"body": "string",
"created_at": "2025-07-16T09:20:11.089Z",
"status_pages": [
{
"id": "string",
"url": "string",
"external_id": "string",
"name": "string",
"display_name": "string",
"integration": {
"id": "string",
"integration_name": "string",
"integration_slug": "string",
"display_name": "string",
"created_at": "2025-07-16T09:20:11.089Z"
}
}
],
"conversations": [
{
"id": "string",
"resource_class": "string",
"resource_id": "string",
"field": "string",
"comments_url": "string",
"channel": {
"name": "string"
}
}
]
},
"report_id": "string",
"ai_incident_summary": "string",
"services": [
{
"id": "string",
"name": "string"
}
],
"environments": [
{
"id": "string",
"name": "string"
}
],
"functionalities": [
{
"id": "string",
"name": "string"
}
],
"channel_name": "string",
"channel_reference": "string",
"channel_id": "string",
"channel_status": "string",
"incident_tickets": [
{
"id": "string",
"summary": "string",
"description": "string",
"state": "open",
"type": "incident",
"assignees": [
{
"id": "string",
"name": "string",
"source": "string",
"email": "string"
}
],
"priority": {
"id": "string",
"name": "string",
"position": 0,
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z"
},
"created_by": {
"id": "string",
"name": "string",
"source": "string",
"email": "string"
},
"attachments": [
{}
],
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"tag_list": [
"string"
],
"incident_id": "string",
"incident_name": "string",
"incident_current_milestone": "string",
"task_id": "string",
"due_at": "2025-07-16T09:20:11.089Z",
"sync_error_message": "string",
"link": {
"id": "string",
"type": "string",
"display_text": "string",
"href_url": "string",
"icon_url": "string",
"editable": true,
"deletable": true
}
}
],
"ticket": {
"id": "string",
"summary": "string",
"description": "string",
"state": "open",
"type": "incident",
"assignees": [
{
"id": "string",
"name": "string",
"source": "string",
"email": "string"
}
],
"priority": {
"id": "string",
"name": "string",
"position": 0,
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z"
},
"created_by": {
"id": "string",
"name": "string",
"source": "string",
"email": "string"
},
"attachments": [
{}
],
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"tag_list": [
"string"
],
"incident_id": "string",
"incident_name": "string",
"incident_current_milestone": "string",
"task_id": "string",
"due_at": "2025-07-16T09:20:11.089Z",
"sync_error_message": "string",
"link": {
"id": "string",
"type": "string",
"display_text": "string",
"href_url": "string",
"icon_url": "string",
"editable": true,
"deletable": true
}
},
"impacts": [
{
"id": "string",
"type": "customer",
"impact": {
"id": "string",
"name": "string"
},
"condition": {
"id": "string",
"name": "string",
"position": 0
},
"conversations": [
{
"id": "string",
"resource_class": "string",
"resource_id": "string",
"field": "string",
"comments_url": "string",
"channel": {
"name": "string"
}
}
]
}
],
"conference_bridges": [
{
"id": "string",
"attachments": [
{}
],
"has_translated_transcripts": true,
"language_codes": [
"string"
],
"transcription_status": "string",
"transcription_sub_code": "string"
}
],
"incident_channels": [
{
"id": "string",
"name": "string",
"source": "string",
"source_name": "string",
"source_id": "string",
"url": "string",
"icon_url": "string",
"status": "string"
}
],
"retro_exports": [
{}
],
"created_by": {
"id": "string",
"name": "string",
"source": "string",
"email": "string"
},
"context_object": {
"object_type": "string",
"object_id": "string",
"context_tag": "string",
"context_description": "string"
},
"team_assignments": [
{
"id": "string",
"status": "string",
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"team": {
"id": "string",
"name": "string",
"description": "string",
"slug": "string",
"created_at": "2025-07-16T09:20:11.089Z",
"updated_at": "2025-07-16T09:20:11.089Z",
"signals_ical_url": "string",
"created_by": {
"id": "string",
"name": "string",
"source": "string",
"email": "string"
},
"in_support_hours": true
}
}
],
"conversations": [
{
"id": "string",
"resource_class": "string",
"resource_id": "string",
"field": "string",
"comments_url": "string",
"channel": {
"name": "string"
}
}
],
"custom_fields": [
{
"name": "string",
"value_type": "string",
"display_name": "string",
"description": "string",
"slug": "string",
"field_id": "string",
"value_array": [
"string"
],
"value_string": "string",
"value": "string"
}
],
"field_requirements": [
{
"field_id": "string",
"required_at_milestone_id": "string"
}
]
}
],
"pagination": {
"count": 0,
"page": 0,
"items": 0,
"pages": 0,
"last": 0,
"prev": 0,
"next": 0
}
}
Workflow Library Example
List Incidents with Firehydrant and Send Results Via Email