Skip to main content
GET
/
api
/
public
/
v1
/
report-schedules
List report schedules
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/report-schedules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "templateName": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyName": "<string>",
      "relativeDateRange": "<string>",
      "customDaysBack": 123,
      "dayOfWeek": 3,
      "dayOfMonth": 16,
      "runTime": "<string>",
      "nextRunAt": "2023-11-07T05:31:56Z",
      "lastRunAt": "2023-11-07T05:31:56Z",
      "emailEnabled": true,
      "emailSubject": "<string>",
      "includePdfAttachment": true,
      "lastError": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:20

Items per page

Required range: 1 <= x <= 100
​
orderBy
enum<string>
default:next_run_at

Field to sort by

Available options:
name,
next_run_at,
created_at
​
orderDirection
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
​
companyId
string<uuid>

Filter by company ID

​
status
enum<string>

Filter by schedule status

Available options:
active,
paused,
completed,
error

Response

List of report schedules

​
data
object[]
required

Array of report schedules

​
pagination
object
required