---
canonical_url: "https://docs.composio.dev/toolkits/ilert"
markdown_url: "https://docs.composio.dev/toolkits/ilert.md"
product: "platform"
version: null
last_updated: null
---

# iLert

iLert is an incident response platform for managing alerts, on-call schedules, escalations, incidents, and status pages.

- **Category:** it operations
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `ILERT`
- **Version:** 00000000_00

## Tools

### Get Alert

**Slug:** `ILERT_GET_ALERT`

Get one iLert alert by its numeric ID, optionally expanding escalation rules, the next escalation user, or custom details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Optional alert expansions. Supported values are escalationRules, nextEscalationUser, and customDetails. |
| `alert_id` | integer | Yes | Numeric iLert alert ID returned by List Alerts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `ILERT_GET_CURRENT_USER`

Return the authenticated iLert user, including identity, role, timezone, and active team context. Use this to verify who the API key represents before incident-response work.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Incident

**Slug:** `ILERT_GET_INCIDENT`

Get one iLert status incident by numeric ID, optionally including subscription state, affected teams, or history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Optional incident expansions. Supported values are subscribed, affectedTeams, and history. |
| `incident_id` | integer | Yes | Numeric incident ID returned by List Incidents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alerts

**Slug:** `ILERT_LIST_ALERTS`

List iLert alerts with optional state, source, escalation-policy, responder, and report-time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `states` | array | No | Alert states to include: PENDING, ACCEPTED, or RESOLVED. |
| `from_time` | string | No | Inclusive ISO-8601 UTC lower bound based on the alert reportTime. |
| `policy_ids` | array | No | Escalation policy IDs to include. |
| `source_ids` | array | No | Alert source IDs to include. |
| `until_time` | string | No | ISO-8601 UTC upper bound based on the alert reportTime. |
| `max_results` | integer | No | Maximum alerts in this page (1-100). |
| `next_cursor` | string | No | Continuation cursor returned by this tool. It retains the filters and page size; omit it for the first page. |
| `responder_ids` | array | No | Responder user IDs to include. |
| `include_next_escalation_user` | boolean | No | Include the next escalation user in each alert. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Incidents

**Slug:** `ILERT_LIST_INCIDENTS`

List iLert status incidents with optional lifecycle-state, affected-service, and report-time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `states` | array | No | Incident states to include: INVESTIGATING, IDENTIFIED, MONITORING, or RESOLVED. |
| `from_time` | string | No | Inclusive ISO-8601 UTC lower bound based on reportTime. |
| `until_time` | string | No | ISO-8601 UTC upper bound based on reportTime. |
| `max_results` | integer | No | Maximum incidents in this page (1-100, or 1-25 when include_subscribed is true). |
| `next_cursor` | string | No | Continuation cursor returned by this tool. It retains the filters and page size; omit it for the first page. |
| `service_ids` | array | No | Affected service IDs to include. |
| `include_subscribed` | boolean | No | Include whether the current user is subscribed to each incident. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List On Calls

**Slug:** `ILERT_LIST_ON_CALLS`

Find who is on call for selected escalation policies, schedules, users, and a time window of at most three months. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | string ("policy" | "escalationPolicy" | "user") | No | Entity to expand in results: policy, escalationPolicy, or user. |
| `user_id` | integer | No | User ID to filter duties. |
| `timezone` | string | No | IANA timezone used to render results. |
| `from_time` | string | No | ISO-8601 UTC start; defaults upstream to the current time. |
| `policy_id` | integer | No | Escalation policy ID to filter duties. |
| `until_time` | string | No | ISO-8601 UTC end after from_time. The range may span at most three calendar months. |
| `max_results` | integer | No | Maximum on-call duties in this page (1-250). |
| `next_cursor` | string | No | Continuation cursor returned by this tool. It retains the filters and page size; omit it for the first page. |
| `schedule_id` | integer | No | On-call schedule ID to filter duties. |
| `policy_level` | object | No | Filter by one escalation-policy level using an object with integer id (policy ID) and integer level (escalation level), for example {id: 123, level: 2}. Cannot be combined with policy_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resources

**Slug:** `ILERT_LIST_RESOURCES`

List one incident-response resource catalog: services, teams, escalation policies, or maintenance windows. Use returned IDs as filters or references in alert, incident, and on-call tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Services only: optional subscribed, uptime, or incidents expansions. |
| `from_time` | string | No | Maintenance windows only: ISO-8601 UTC lower bound. |
| `member_id` | integer | No | Teams only: return teams containing this one member ID. |
| `source_ids` | array | No | Maintenance windows only: filter by alert source IDs. |
| `until_time` | string | No | Maintenance windows only: ISO-8601 UTC upper bound. |
| `max_results` | integer | No | Maximum resources in this page (1-20). |
| `next_cursor` | string | No | Continuation cursor returned by this tool. It retains the resource type, filters, and page size; omit it for the first page. |
| `service_ids` | array | No | Maintenance windows only: filter by service IDs. |
| `resource_type` | string ("services" | "teams" | "escalation_policies" | "maintenance_windows") | Yes | Catalog to list: services, teams, escalation_policies, or maintenance_windows. |
| `maintenance_state` | string ("OPEN" | "CLOSED") | No | Maintenance windows only: OPEN or CLOSED. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Schedules

**Slug:** `ILERT_LIST_SCHEDULES`

List iLert on-call schedules, optionally expanding current or next shifts and schedule definitions. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Optional expansions: scheduleLayers, shifts, currentShift, nextShift, or past. scheduleLayers applies to recurring schedules; shifts and past apply to static schedules. |
| `max_results` | integer | No | Maximum schedules in this page (1-20). |
| `next_cursor` | string | No | Continuation cursor returned by this tool. It retains expansions and page size; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
