Get list of tasks

GET 
/v2/actor-tasks

Gets the complete list of tasks that a user has created or used.

The response is a list of objects in which each object contains essential information about a single task.

The endpoint supports pagination using the limit and offset parameters, and it does not return more than a 1000 records.

By default, the records are sorted by the createdAt field in ascending order; therefore you can use pagination to incrementally fetch all tasks while new ones are still being created. To sort the records in descending order, use the desc=1 parameter.

Request

Query Parameters

offset double
Number of records that should be skipped at the start. The default value is 0.

Example: 10
limit double
Maximum number of records to return. The default value as well as the maximum is 1000.

Example: 99
desc boolean
If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.

Example: true

Status 200

Response Headers

{
  "data": {
    "total": 2,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 2,
    "items": [
      {
        "id": "zdc3Pyhyz3m8vjDeM",
        "userId": "wRsJZtadYvn4mBZmm",
        "actId": "asADASadYvn4mBZmm",
        "actName": "my-actor",
        "name": "my-task",
        "username": "janedoe",
        "actUsername": "janedoe",
        "createdAt": "2018-10-26T07:23:14.855Z",
        "modifiedAt": "2018-10-26T13:30:49.578Z",
        "stats": {
          "totalRuns": 15
        }
      },
      {
        "id": "aWE3asdas3m8vjDeM",
        "userId": "wRsJZtadYvn4mBZmm",
        "actId": "asADASadYvn4mBZmm",
        "actName": "my-actor",
        "actUsername": "janedoe",
        "name": "my-task-2",
        "username": "janedoe",
        "createdAt": "2018-10-26T07:23:14.855Z",
        "modifiedAt": "2018-10-26T13:30:49.578Z",
        "stats": {
          "totalRuns": 4
        }
      }
    ]
  }
}

Schema

• data object required

  Common pagination fields for list responses.

  • total integer required

    The total number of items available across all pages.

    Possible values: >= 0

    
    Example: 2
  • offset integer required

    The starting position for this page of results.

    Possible values: >= 0

    
    Example: 0
  • limit integer required

    The maximum number of items returned per page.

    Possible values: >= 1

    
    Example: 1000
  • desc boolean required

    Whether the results are sorted in descending order.

    
    Example: false
  • count integer required

    The number of items returned in this response.

    Possible values: >= 0

    
    Example: 2
  • items object[] required

    • id string required
      Example: zdc3Pyhyz3m8vjDeM
    • userId string required
      Example: wRsJZtadYvn4mBZmm
    • actId string required
      Example: asADASadYvn4mBZmm
    • actName string | null nullable
      Example: my-actor
    • name string required
      Example: my-task
    • username string | null nullable
      Example: janedoe
    • actUsername string | null nullable
      Example: janedoe
    • createdAt string<date-time> required
      Example: 2018-10-26T07:23:14.855Z
    • modifiedAt string<date-time> required
      Example: 2018-10-26T13:30:49.578Z
    • stats object

      anyOf
      • TaskStats
      • null
      totalRuns integer
      Example: 15

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)