Actor builds

Get list of user's Actor builds

Changed on

Gets a list of all builds for a user. The response is a JSON array of objects, where each object contains basic information about a single build.

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 startedAt field in ascending order. Therefore, you can use pagination to incrementally fetch all builds while new ones are still being started. To sort the records in descending order, use the desc=1 parameter.

get/v2/actor-builds

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

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.

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "count": 1,
    "items": [
      {
        "id": "HG7ML7M8z78YcAPEB",
        "actId": "janedoe~my-actor",
        "userId": "klmdEpoiojmdEMlk3",
        "startedAt": "2019-11-30T07:34:24.202Z",
        "finishedAt": "2019-12-12T09:30:12.202Z",
        "usageTotalUsd": 0.02,
        "buildNumber": "0.1.1",
        "buildNumberInt": 10000,
        "meta": {
          "clientIp": "172.234.12.34",
          "userAgent": "Mozilla/5.0 (iPad)",
          "githubActionsRunUrl": "https://github.com/apify/my-actor/actions/runs/123456789",
          "actorRunId": "HG7ML7M8z78YcAPEB",
          "webhookDispatchId": "Zib4xbZsmvZeK55ua"
        }
      }
    ]
  }
}

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • breaking

      the response property //// became optional for the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status