GET
/
api
/
{projectId}
/
jobs
List active jobs
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/jobs \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "jobs": [
    {
      "id": 123,
      "category": "<string>",
      "categoryKey": "<string>",
      "key": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "started": "2023-11-07T05:31:56Z",
      "finished": "2023-11-07T05:31:56Z",
      "finishedSuccessful": true,
      "jobNotificationUids": [
        123
      ],
      "additionalInfo": "<string>",
      "computeTime": 123,
      "createdByUser": {
        "id": 123,
        "name": "<string>",
        "username": "<string>",
        "photo": "<string>"
      },
      "categoryCount": 123,
      "metadata": {}
    }
  ],
  "totalJobCount": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Query Parameters

​
rootOnly
boolean

Whether to exclude jobs with a parent ID (so jobs started as part of another job)

Response

200 - application/json

OK

The response is of type object.