Skip to main content

Schedules

  GET https://api.letpay.io/myreports/schedule?size=3

Retrieve the List of Reports with Scheduled Execution​

This endpoint is used to retrieve the list of reports that have scheduled executions.

Authorization​

AUTHORIZATIONAPI Key
KeyX-Auth-Token
ValueMY_ACCESS_TOKEN

Example Request​

Example Request​

200 - OK
    curl --location -g --request PUT 'https://api.letpay.io/myreports/schedule?size=2' \
    --params 'size=2' \
    --header 'X-Auth-Token: MY_ACCESS_TOKEN' \

Example Response​

Header
  Content-Type: application/json
Body
    {
      "content": [
        {
          "id": 21,
          "report": {
            "id": 183,
            "name": "Po1553"
          },
          "run_every": "WEEKLY",
          "day_of_week": "SUNDAY",
          "day_of_month": null,
          "run_at": "08:07:00",
          "recipient": "[email protected]",
          "next_execution": "2024-12-10T08:07:00",
          "last_execution": "2024-12-10T12:00:00.036516",
          "enable": true
        },
        {
          "id": 33,
          "report": {
            "id": 186,
            "name": "MC-ALL"
          },
          "run_every": "MONTHLY",
          "day_of_week": null,
          "day_of_month": 1,
          "run_at": "08:00:00",
          "recipient": "[email protected]",
          "next_execution": "2025-01-01T08:00:00",
          "last_execution": null,
          "enable": true
        }
      ],
      "pageable": {
        "sort": {
          "empty": true,
          "sorted": false,
          "unsorted": true
        },
        "offset": 0,
        "pageSize": 2,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
      },
      "last": false,
      "totalElements": 40,
      "totalPages": 20,
      "first": true,
      "size": 2,
      "number": 0,
      "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
      },
      "numberOfElements": 2,
      "empty": false
    }