Platform APIEnterprise
List timer tasks
List a user's timer tasks, optionally restricted to selected business categories.
HTTP request
POST {API_ADDRESS}/timer/list_timer_taskRequest example
curl --request POST "${API_ADDRESS}/timer/list_timer_task" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"pageCount":1,"pageSize":20,"userID":"user_001","categories":["reminder"]}'Request body
| Parameter | Required | Type | Description |
|---|---|---|---|
| pageCount | Yes | int | Page number starting at 1. |
| pageSize | Yes | int | Number of records per page. |
| userID | Yes | string | User whose tasks are queried. |
| categories | Yes | string[] | Business category filters. |
Response
data.tasks contains an array of TimerTask records.
Errors
See Error codes.
Permissions and limits
- Available only in OpenIM Enterprise.
- Page-size limits follow the delivered server version.
Related pages
Was this page helpful?