Get a report runner

Returns the full report runner definition for the supplied id, including its schedule, report type, parameters, formats, and delivery configuration. Returns 404 report_runner_not_found if the id does not exist.

get/v7/report-runners/{reportRunnerId}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v7/report-runners/:reportRunnerId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

reportRunnerIdstring required

The Extole unique report runner identifier.

Response

Report runner.

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "pause_info": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "paused": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
  "sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}",
  "updated_date": "2025-10-24T02:00:00-07:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.