---
title: "List report runners"
method: GET
path: "/v7/report-runners"
tags: ["Report Schedules"]
---

# List report runners

`GET /v7/report-runners`

Returns report runners for the calling client, filtered and ordered by the supplied query parameters. Report runners are scheduled report execution definitions that run a report type on a recurring schedule and deliver output to a configured destination (e.g. SFTP). Use `GET /v7/report-runners/template` to retrieve the available runner templates.

## Query parameters

- `type` string
- `report_type` string
- `display_name` string
- `user_ids` string[]
- `having_any_tags` string
- `having_all_tags` string
- `exclude_having_any_tags` string
- `exclude_having_all_tags` string
- `search_query` string
- `pause_status` string
- `aggregation_status` string
- `offset` string
- `limit` string
- `order_by` string
- `order` string
- `report_type_name` string

## Response `200`

Successful response

- ReportRunnerResponse[]
  - union
    - object
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `deliver_empty_reports_to_sftp` boolean, required
      - `enabled` boolean, required
      - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE', required
      - `formats` string[], required
      - `id` string, required
      - `merging_configuration` MergingConfigurationResponse, required
        - `deliverable_type` 'ACCUMULATING' | 'INDIVIDUAL' | 'NEW_ENTRIES'
        - `formats` string[]
        - `sort_by` string[]
        - `unique_by` string[]
      - `name` string, required
      - `parameters` object, required
      - `pause_info` PauseInfoResponse, required
        - `description` string
        - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.
        - `user_id` string
      - `paused` PauseInfoResponse, required
        - `description` string
        - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.
        - `user_id` string
      - `report_name_pattern` union, required — The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
        - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
      - `report_type` string, required
      - `report_type_name` string, required
      - `scopes` string[], required
      - `sftp_report_name_pattern` union, required — The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
        - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
      - `sftp_server_id` string, nullable, required
      - `tags` string[], required
      - `type` 'REFRESHING', required
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `user_id` string, required
      - `expiration_ms` integer, required
    - object
      - `component_ids` string[], required
      - `component_references` ComponentReferenceResponse[], required
        - `component_id` string
        - `socket_names` string[]
      - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `deliver_empty_reports_to_sftp` boolean, required
      - `enabled` boolean, required
      - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE', required
      - `formats` string[], required
      - `id` string, required
      - `merging_configuration` MergingConfigurationResponse, required
        - `deliverable_type` 'ACCUMULATING' | 'INDIVIDUAL' | 'NEW_ENTRIES'
        - `formats` string[]
        - `sort_by` string[]
        - `unique_by` string[]
      - `name` string, required
      - `parameters` object, required
      - `pause_info` PauseInfoResponse, required
        - `description` string
        - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.
        - `user_id` string
      - `paused` PauseInfoResponse, required
        - `description` string
        - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds.
        - `user_id` string
      - `report_name_pattern` union, required — The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
        - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
      - `report_type` string, required
      - `report_type_name` string, required
      - `scopes` string[], required
      - `sftp_report_name_pattern` union, required — The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically.
        - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
        - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts).
      - `sftp_server_id` string, nullable, required
      - `tags` string[], required
      - `type` 'SCHEDULED', required
      - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
      - `user_id` string, required
      - `frequency` 'DAILY' | 'HOURLY' | 'LOGIN' | 'MONTHLY' | 'QUARTERLY' | 'WEEKLY', required
      - `legacy_sftp_report_name_format` boolean, required
      - `schedule_start_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/versions/c16e62e66755/schema)