v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

Account

Get a list of account level tasks

List tasks which are not associated with a specific site

get/v1/account/tasks

Query parameters

task_idstring uuid

ID of this task

Example:01d680d5-de78-4e26-a380-5f7ad2c0877f

task_type'create_site_from_template' | 'create_site_template'

Type of task. create_site_from_template = create a new site from a site template

Example:create_site_from_template

task_status'DONE' | 'ERROR' | 'NEW' | 'PROGRESS'

Current state/status of the task

pageinteger

Page of results to include (default = 1)

per_pageinteger

Results per page

Example:10

sort'id' | 'perc' | 'task_status' | 'task_type' | 'updated'

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": "01d680d5-de78-4e26-a380-5f7ad2c0877f",
      "account_user_id": 90099099,
      "user_id": "298348a3-c006-46a3-86c2-bb6922b6e452",
      "perc": 90,
      "updated": "2024-01-01T02:00:00Z",
      "created": "2024-01-01T02:00:00Z",
      "message": "task execution timed out",
      "task_type": "create_site_from_template",
      "meta_data": {
        "key": "value"
      },
      "task_level": "account"
    }
  ]
}