Skip to content
API Reference
/
/
/
List RPA Schedules

List RPA Schedules

Request

List RPA schedules for the team, page by page.

  • Effect: none. Read-only. Safe to retry with bounded backoff.
  • Use: taskState on each schedule is the completion signal for /cloudphone/rpa/task/cancel.
Security
Authorization
Bodyapplication/jsonrequired
enabledboolean or null

Is the plan enabled

searchKeystring or null

Fuzzy search across schedule name, description, and template title

taskStateinteger or null

Schedule status; 0:awaiting execution; 1:Executing; 2:Execution completed 3:Cancel

pageNointeger or null

default:1

pageSizeinteger or null

default:10

curl -i -X POST \
  https://api.morelogin.com/cloudphone/rpa/task/page \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageNo": 1,
    "pageSize": 10,
    "taskState": 0,
    "searchKey": "daily login",
    "enabled": true
  }'

Responses

Success. data.dataList holds the records for the requested page and is an empty array when there are no matches; data.total, data.current and data.pages describe the paging.

Headers
any
Bodyapplication/json
codeintegerrequired

Response code, 0 indicates success,>0 indicates failure

msgstring or nullrequired

Error msg

requestIdstringrequired

Request trace id

dataobjectrequired
Response
{
  "code": 0,
  "msg": null,
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d",
  "data": {
    "dataList": [ … ],
    "current": "1",
    "pages": "1",
    "total": "1"
  }
}