Get list of tasks

GET 
https://api.apify.com/v2/actor-tasks

ClientsGets 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.

limit double

Maximum number of records to return. The default value as well as the maximum is 1000.

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.

Responses

200

Response Headers

application/json

Schema

Schema

data object
totalnumberrequired
Example: 2
offsetnumberrequired
Example: 0
limitnumberrequired
Example: 1000
descbooleanrequired
Example: false
countnumberrequired
Example: 2
items object[]required
Array [
idstringrequired
Example: zdc3Pyhyz3m8vjDeM
userIdstringrequired
Example: wRsJZtadYvn4mBZmm
actIdstringrequired
Example: asADASadYvn4mBZmm
actNamestringrequired
Example: my-actor
namestringrequired
Example: my-task
usernamestringnullable
Example: janedoe
actUsernamestringrequired
Example: janedoe
createdAtstringrequired
Example: 2018-10-26T07:23:14.855Z
modifiedAtstringrequired
Example: 2018-10-26T13:30:49.578Z
stats object
oneOf
MOD1
TaskStats
totalRunsnumberrequired
Example: 15
]

Example (auto)

{
  "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"
      }
    ]
  }
}

Example

{
  "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
        }
      }
    ]
  }
}

Authorization: http

name: httpBearertype: httpscheme: bearerdescription: API authentication token.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• CURL

curl -L 'https://api.apify.com/v2/actor-tasks' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

Parameters

offset — query

limit — query

desc — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!