--- title: "List Report Schedules" method: GET path: "/reportSchedules" tags: ["Report Scheduling"] --- # List Report Schedules `GET /reportSchedules` ## Request - Base URL: `https://eu-west-1.api.silverflow.com/v1` - URL: `https://eu-west-1.api.silverflow.com/v1/reportSchedules` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists all active report schedules. It requires the `reportSchedules:List` permission in the API key. ## Query parameters - `reportName` 'SchemeFeeDetails': The name of the report. - `limit` integer - `offsetToken` string - `sortOrder` 'asc' | 'desc' ## Response `200` The report schedules - ListReportSchedulesResponse - `moreItems` boolean, required: Boolean indicating if there are more items to retrieve - `offsetToken` string - `items` union[], required: List of report schedules - union - SchemeFeeDetailsReportSchedule - `reportName` 'SchemeFeeDetails', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'application/json' | 'application/x-ndjson' | 'text/csv', required: The mime-type in which the scheme fee details report is available. - `trigger` union, required: The trigger conditions for the scheme fee details report schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - NetworkFundsTransferReportSchedule - `reportName` 'NetworkFundsTransfers', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the network funds transfers report is available. - `trigger` NetworkFundsTransfersTrigger, required: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - MerchantPayoutReportSchedule - `reportName` 'MerchantPayout', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv', required: The mime-type in which the MerchantPayout report is available. - `trigger` MerchantPayoutScheduleTrigger, required: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - `parameters` MerchantPayoutReportScheduleParameters, required: The parameters used for creating a merchant payout report schedule. - `type` 'Standardized', required - ReconciliationDetailsReportSchedule - `reportName` 'ReconciliationDetails', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the reconciliation details report is available. - `trigger` union, required: The trigger conditions for the reconciliation details schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - ChargesReportSchedule - `reportName` 'Charges', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv', required: The mime-type in which the Charges report is available. - `trigger` union, required: The trigger conditions for the Charges report schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - DisputeHistoryEventsReportSchedule - `reportName` 'DisputeHistoryEvents', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the disputes report is available. - `trigger` union, required: The trigger conditions for the Dispute History Events report schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - FraudNotificationsReportSchedule - `reportName` 'FraudNotifications', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv' | 'application/json' | 'application/x-ndjson', required: The mime-type in which the fraud notifications report is available. - `trigger` union, required: The trigger conditions for the Fraud Notifications report schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - SettlementDetailsReportSchedule - `reportName` 'SettlementDetails', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'text/csv' | 'application/x-ndjson', required: The mime-type in which the SettlementDetails report is available. - `trigger` union, required: The trigger conditions for the SettlementDetails schedule. - object: Configuration for hourly-triggered reports. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'hourly', required: The cadence of this interval trigger. - object: Configuration for daily-triggered reports, specifying the hour. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'daily', required: The cadence of this interval trigger. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. - AmmfReportSchedule - `reportName` 'AmmfReport', required: The name of the report. - `key` string, required: Uniquely identifies a report schedule object - `status` 'active' | 'archived', required: Current state of the report schedule. - **active**: Schedule is currently enabled and will trigger as per configuration. - **archived**: Schedule is disabled and will not trigger. - `agentKey` string, required: Uniquely identifies an Agent - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `reference` string: Unique ID used to identify a report. - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed. - `mimeType` 'application/vnd.ms-excel', required: The mime-type in which the AMMF Report is available. - `parameters` AMMFReportScheduleParameters, required: The parameters used for creating a merchant payout report schedule. - `acquirerIdCode` string, required: the Acquirer Institution ID. For Visa, this is the BIC. It should be a 6-digit numeric value. - `directSubmission` boolean: set to `true` to indicate that the AMMF report should be directly submitted to Visa's AMMF service - `trigger` AmmfReportScheduleTrigger, required: Configuration for monthly-triggered reports, specifying the day of the month and hour the report should be scheduled. - `type` 'interval', required: A trigger type, which is based on a time-interval. - `cadence` 'monthly', required - `day` integer, required: The day of the month for the report trigger. - Must be between 1 and 28. - `hour` integer, required: The hour of the day (in 24-hour format) for the report trigger. - Must be between 0 and 23. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: The authenticated client is forbidden to make the request for the resource identified. - `429`: The number of requests (per minute) has exceeded the configured maximum --- [API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)