GET v1/jobs-queue/{environment}/{orgId}/{appId}?pageIndex={pageIndex}&itemsPerPage={itemsPerPage}&orderBy={orderBy}&sort={sort}
This method returns all jobs associated with the specified entity id. This method by default returns only the first page with a maximum of 20 jobs per page. The appropriate behavior is that as needed, the caller increments page id until the amount of items per page return is less than itemsPerPage. This method returns all jobs for all levels within an org, included jobs at the org level.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org was created. |
string |
Required |
| orgId |
Org for which to return created jobs. |
integer |
Required |
| appId |
App Id for which to retrieve associated jobs. |
integer |
Required |
| pageIndex |
Page index to return. |
integer |
Default value is 0 |
| itemsPerPage |
Items per page to return. Default value is 20. |
integer |
Default value is 20 |
| orderBy |
You can optionally specify which of the built-in fields the results can be ordered by, these are Name, Date or Status explicitly and they can not be combined. |
JobsSortByOptions |
Default value is Default |
| sort |
This field specifies the direction you which the result to be sorted, this is Ascending or Descending. For this particular API, Default is a synonym of Ascending. |
SortOption |
Default value is Default |
Body Parameters
None.
Response Information
Resource Description
Collection of QueueJobModel| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Queue UUID |
string |
None. |
| entity | Entity |
None. |
|
| settings |
Collection of sys queue items |
Collection of QueueJobSetting |
None. |
| type |
Queue type |
QueueJobType |
None. |
| created |
Created date-time |
date |
None. |
| updated |
Updated date-time |
date |
None. |
| status |
Status UUID |
QueueJobStatus |
None. |
| log |
List of entries for each cycle the job has run for. |
Collection of QueueJobLogEntry |
None. |
| name |
Job Custom display name. |
string |
None. |
| schedule |
Scheduled date and time when to run this job. If null or in the past, the system will run the job as soon as is picked up by the "System Queue". |
date |
None. |
| favorite |
Set to true if the job is a favorite job. |
boolean |
None. |
| recurrent |
Use this property to mark a job as been recurrent. This property will automatically be set to false if interval is not provided or less than 1. |
boolean |
None. |
| interval |
Recurrence interval used for recurrent jobs in seconds. Recurrence is a hint to the system queue, but ultimately is governed by the cycle interval internal to the system queue. If the system queue cycle interval is set to say one minute. Setting a job interval to less than one minute will simply cause the job to be run on every cycle. |
integer |
None. |
Response Formats
application/json, text/json
[
{
"id": "sample string 1",
"entity": {
"type": 1
},
"settings": [
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
},
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
}
],
"type": {
"id": "sample string 1",
"platform": 2.1,
"internalName": "sample string 3",
"name": "sample string 4",
"description": "sample string 5",
"hidden": true,
"settings": [
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
},
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
}
],
"requiresVenue": true
},
"created": "2025-06-26T09:05:28.7752793-07:00",
"updated": "2025-06-26T09:05:28.7752793-07:00",
"status": {
"id": "sample string 1",
"internalName": "sample string 2",
"name": "sample string 3"
},
"archived": false,
"log": [
{
"status": "sample string 1",
"date": "2025-06-26T09:05:28.7752793-07:00",
"log": "sample string 3"
},
{
"status": "sample string 1",
"date": "2025-06-26T09:05:28.7752793-07:00",
"log": "sample string 3"
}
],
"name": "sample string 3",
"schedule": "2025-06-26T09:05:28.7752793-07:00",
"favorite": true,
"recurrent": true,
"interval": 1
},
{
"id": "sample string 1",
"entity": {
"type": 1
},
"settings": [
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
},
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
}
],
"type": {
"id": "sample string 1",
"platform": 2.1,
"internalName": "sample string 3",
"name": "sample string 4",
"description": "sample string 5",
"hidden": true,
"settings": [
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
},
{
"id": "sample string 1",
"name": "sample string 2",
"value": "sample string 7",
"label": "sample string 8",
"extraLabel": "sample string 9",
"step": 10,
"isTemplate": true
}
],
"requiresVenue": true
},
"created": "2025-06-26T09:05:28.7752793-07:00",
"updated": "2025-06-26T09:05:28.7752793-07:00",
"status": {
"id": "sample string 1",
"internalName": "sample string 2",
"name": "sample string 3"
},
"archived": false,
"log": [
{
"status": "sample string 1",
"date": "2025-06-26T09:05:28.7752793-07:00",
"log": "sample string 3"
},
{
"status": "sample string 1",
"date": "2025-06-26T09:05:28.7752793-07:00",
"log": "sample string 3"
}
],
"name": "sample string 3",
"schedule": "2025-06-26T09:05:28.7752793-07:00",
"favorite": true,
"recurrent": true,
"interval": 1
}
]