Queued Tasks

GET /api/users/tasks/queued

Get queued tasks.

Scope: tasks:read

Minimum role: Administrator

Example request:

GET /api/tasks/queued HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "counts": {
    "user_data_export": 0,
    "workouts_archive_upload": 1
  },
  "status": "success"
}
Status Codes:
  • 200 OKsuccess

  • 401 Unauthorized

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again

  • 403 Forbidden

    • you do not have permissions

GET /api/users/tasks/queued/(string: task_type)

Get queued tasks for a given type

Scope: tasks:read

Minimum role: Administrator

Example request:

GET /api/config HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "pagination": {
    "has_next": false,
    "has_prev": false,
    "page": 1,
    "pages": 1,
    "total": 1
  },
  "queued_tasks": [
    {
      "created_at": "Mon, 21 Apr 2025 14:24:53 GMT",
      "file_size": 21750,
      "files_count": 30,
      "id": "5RnDqwLuANmDKRqFhkgJsh",
      "message_id": "3542fd2d-e8f7-438f-b018-0fd49176728a",
      "status": "queued",
      "type": "workouts_archive_upload",
      "user": {
        "blocked": false,
        "created_at": "Sun, 01 Dec 2024 17:27:49 GMT",
        "email": "sam@example.com",
        "followers": 0,
        "following": 0,
        "follows": "false",
        "is_active": true,
        "is_followed_by": "false",
        "nb_workouts": 1,
        "picture": false,
        "role": "user",
        "suspended_at": null,
        "username": "Sam"
      }
    }
  ],
  "status": "success"
}
Status Codes: