1 of 1

White Label Admin - Get organization jobs

White label admin only API to get the list of all jobs for a organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

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

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

External job identifier, this can be used to categorize jobs, and recover job status. E.g. set this to 'keras-192' for a Keras learning block with ID 192. When a user refreshes the page you can check whether a job is active for this ID and re-attach.

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "jobs": [
    {
      "id": 0,
      "category": "text",
      "key": "text",
      "created": "2025-01-12T13:39:20.270Z",
      "started": "2025-01-12T13:39:20.270Z",
      "finished": "2025-01-12T13:39:20.270Z",
      "finishedSuccessful": false,
      "jobNotificationUids": [
        0
      ],
      "additionalInfo": "text",
      "computeTime": 0,
      "createdByUser": {
        "id": 0,
        "name": "text",
        "username": "text",
        "photo": "text"
      },
      "categoryCount": 0
    }
  ],
  "totalJobCount": 0
}