List all jobs

List all jobs

Get all jobs for this project

get

/api/{projectId}/jobs/all

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Query parameters

startDatestring · date-time

Start date

endDatestring · date-time

End date

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

rootOnlyboolean

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

keystring

Job key to filter on

categorystring

Job category to filter on

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/all' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "totalJobCount": 1,
  "jobs": [
    {
      "id": 1,
      "category": "text",
      "key": "text",
      "created": "2025-02-21T18:12:58.188Z",
      "started": "2025-02-21T18:12:58.188Z",
      "finished": "2025-02-21T18:12:58.188Z",
      "finishedSuccessful": true,
      "additionalInfo": "text",
      "computeTime": 1,
      "createdByUser": {
        "id": 1,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "categoryCount": 1,
      "jobNotificationUids": [
        1
      ]
    }
  ]
}

OK