List workers

Lists the workers that belong to the caller’s active organization, including each worker’s latest known instance state.

GET /v1/workers

List workers

cURL

curl --request GET \
  --url https://api.openworklabs.com/v1/workers

200

{
  "workers": [
    {
      "instance": {
        "provider": "<string>",
        "region": "<string>",
        "url": "<string>",
        "status": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "orgId": "<string>",
      "createdByUserId": "<string>",
      "isMine": true,
      "name": "<string>",
      "description": "<string>",
      "destination": "<string>",
      "status": "<string>",
      "imageVersion": "<string>",
      "workspacePath": "<string>",
      "sandboxBackend": "<string>",
      "lastHeartbeatAt": "2023-11-07T05:31:56Z",
      "lastActiveAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

limit · integer · default: 20

Required range: 1 <= x <= 50

Response

200

application/json

Workers returned successfully.

workers · object[] · required

Show child attributes