Sign in

v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Actors/Actor runs

Get list of runs

Gets the list of runs of a specific Actor. The response is a list of objects, where each object contains basic information about a single Actor run.

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

By default, the records are sorted by the startedAt field in ascending order, therefore you can use pagination to incrementally fetch all records while new ones are still being created. To sort the records in descending order, use desc=1 parameter. You can also filter runs by status (available statuses).

get/v2/actors/{actorId}/runs

Path parameters

actorIdstring required
Example:janedoe~my-actor

Actor ID or a tilde-separated owner's username and Actor name.

Query parameters

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

limitnumber double
Example:1000

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

descboolean
Example:true

If true or 1 then the objects are sorted by the startedAt field in descending order. By default, they are sorted in ascending order.

statusstring[]

Single status or comma-separated list of statuses, see (available statuses). Used to filter runs by the specified statuses only.

[
  "SUCCEEDED"
]
startedAfterstring date-time
Example:2025-09-01T00:00:00.000Z

Filter runs that started after the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).

startedBeforestring date-time
Example:2025-09-17T23:59:59.000Z

Filter runs that started before the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "count": 1,
    "items": [
      {
        "id": "HG7ML7M8z78YcAPEB",
        "actId": "HDSasDasz78YcAPEB",
        "userId": "7sT5jcggjjA9fNcxF",
        "actorTaskId": "KJHSKHausidyaJKHs",
        "startedAt": "2019-11-30T07:34:24.202Z",
        "finishedAt": "2019-12-12T09:30:12.202Z",
        "buildId": "HG7ML7M8z78YcAPEB",
        "buildNumber": "0.0.2",
        "buildNumberInt": 10000,
        "usageTotalUsd": 0.2,
        "defaultKeyValueStoreId": "sfAjeR4QmeJCQzTfe",
        "defaultDatasetId": "3ZojQDdFTsyE7Moy4",
        "defaultRequestQueueId": "so93g2shcDzK3pA85"
      }
    ]
  }
}