Get list of Actors

GET 
https://api.apify.com/v2/acts

ClientsGets the list of all Actors that the user created or used. The response is a list of objects, where each object contains a basic information about a single Actor.

To only get Actors created by the user, add the my=1 query parameter.

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

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

Request

Query Parameters

my boolean

If true or 1 then the returned list only contains Actors owned by the user. The default value is false.

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: br9CKmk457
createdAtstringrequired
Example: 2019-10-29T07:34:24.202Z
modifiedAtstringrequired
Example: 2019-10-30T07:34:24.202Z
namestringrequired
Example: MyAct
usernamestringrequired
Example: janedoe
]

Example (auto)

{
  "data": {
    "total": 2,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 2,
    "items": [
      {
        "id": "br9CKmk457",
        "createdAt": "2019-10-29T07:34:24.202Z",
        "modifiedAt": "2019-10-30T07:34:24.202Z",
        "name": "MyAct",
        "username": "janedoe"
      }
    ]
  }
}

Example

{
  "data": {
    "total": 2,
    "count": 2,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "items": [
      {
        "id": "br9CKmk457",
        "createdAt": "2019-10-29T07:34:24.202Z",
        "modifiedAt": "2019-10-30T07:34:24.202Z",
        "name": "MyAct",
        "username": "janedoe"
      },
      {
        "id": "ksiEKo23pz",
        "createdAt": "2019-11-30T07:34:24.202Z",
        "modifiedAt": "2019-12-12T07:34:24.202Z",
        "name": "MySecondAct",
        "username": "janedoe"
      }
    ]
  }
}

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

• Apify CLI

apify actors ls

• CURL

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

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

Parameters

my — query

---truefalse

offset — query

limit — query

desc — query

---truefalse

ResponseClear

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