Skip to main content
GET
/
api
/
scheduled-job-executions
List Scheduled Job Executions
curl --request GET \
  --url https://platform.kodexa.ai/api/scheduled-job-executions \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "completionMessage": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "exceptionDetails": "<string>",
      "executionStatus": "RUNNING",
      "id": "<string>",
      "logGroup": "<string>",
      "logStream": "<string>",
      "requestId": "<string>",
      "scheduledJob": {
        "active": true,
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "deleted": true,
        "description": "<string>",
        "id": "f5678901-23ab-cdef-4567-890123abcdef",
        "modelRef": "<string>",
        "name": "Daily Invoice Processing",
        "project": {
          "changeSequence": 123,
          "color": "#4A90D9",
          "createdOn": "2023-11-07T05:31:56Z",
          "dataFlow": {
            "edges": [
              {
                "id": "<string>",
                "properties": {},
                "source": "<string>",
                "target": "<string>"
              }
            ],
            "nodes": [
              {
                "dimensions": {
                  "height": 123,
                  "width": 123
                },
                "id": "<string>",
                "parentId": "<string>",
                "position": {
                  "x": 123,
                  "y": 123
                },
                "properties": {},
                "type": "<string>"
              }
            ],
            "viewPort": {
              "x": 123,
              "y": 123,
              "zoom": 123
            }
          },
          "description": "Automated invoice processing pipeline.",
          "documentStatuses": [
            {
              "changeSequence": 123,
              "color": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "icon": "<string>",
              "id": "<string>",
              "project": "<unknown>",
              "projectId": "<string>",
              "slug": "<string>",
              "status": "<string>",
              "statusType": "UNRESOLVED",
              "updatedOn": "2023-11-07T05:31:56Z",
              "uuid": "<string>"
            }
          ],
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "memory": {
            "changeSequence": 123,
            "orderedDashboards": [
              "<string>"
            ],
            "recentFilters": {},
            "recentQueries": {}
          },
          "name": "Invoice Processing",
          "notes": "<string>",
          "options": {
            "companion": {
              "agentRuntimeRef": "<string>",
              "moduleRefs": [
                "<string>"
              ],
              "prompt": "<string>"
            },
            "dataOptions": [
              {
                "aliases": [
                  "<string>"
                ],
                "default": "<unknown>",
                "description": "<string>",
                "developerOnly": true,
                "displayProperties": {},
                "falseLabel": "<string>",
                "featureFlag": "<string>",
                "groupOptions": "<array>",
                "hint": "<string>",
                "label": "<string>",
                "listDescription": "<string>",
                "listLabel": "<string>",
                "listType": "<string>",
                "name": "<string>",
                "overviewMarkdown": "<string>",
                "possibleValues": [
                  {
                    "description": "<string>",
                    "label": "<string>",
                    "value": "<unknown>"
                  }
                ],
                "properties": {},
                "required": true,
                "showIf": "<string>",
                "showOnPopup": true,
                "subType": "<string>",
                "supportArticle": "<string>",
                "tabName": "<string>",
                "type": "<string>"
              }
            ],
            "dataProperties": {},
            "executionPolicy": {
              "backoffBaseSeconds": 123,
              "backoffStrategy": "<string>",
              "maxAttempts": 123,
              "onExhausted": "<string>",
              "timeoutSeconds": 123
            },
            "groupTaxonTypeFeatures": {},
            "options": [
              {
                "aliases": [
                  "<string>"
                ],
                "default": "<unknown>",
                "description": "<string>",
                "developerOnly": true,
                "displayProperties": {},
                "falseLabel": "<string>",
                "featureFlag": "<string>",
                "groupOptions": "<array>",
                "hint": "<string>",
                "label": "<string>",
                "listDescription": "<string>",
                "listLabel": "<string>",
                "listType": "<string>",
                "name": "<string>",
                "overviewMarkdown": "<string>",
                "possibleValues": [
                  {
                    "description": "<string>",
                    "label": "<string>",
                    "value": "<unknown>"
                  }
                ],
                "properties": {},
                "required": true,
                "showIf": "<string>",
                "showOnPopup": true,
                "subType": "<string>",
                "supportArticle": "<string>",
                "tabName": "<string>",
                "type": "<string>"
              }
            ],
            "properties": {},
            "taskOptions": {
              "showNewTask": true,
              "showTakeNext": true
            },
            "taxonTypeFeatures": {}
          },
          "organization": {
            "authGroupLink": {
              "authGroup": "<string>"
            },
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "defaultToPrivateTemplates": true,
            "description": "Document processing organization for Acme Corp.",
            "enterpriseOrganization": true,
            "features": {},
            "hasImage": true,
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "memory": {
              "orderedDashboards": [
                "<string>"
              ]
            },
            "name": "Acme Corp",
            "organizationStatus": "ACTIVE",
            "properties": {},
            "publicAccess": true,
            "searchText": "<string>",
            "slug": "acme-corp",
            "stripeCustomerId": "<string>",
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "550e8400e29b41d4a716446655440000"
          },
          "organizationId": "<string>",
          "owner": {
            "active": true,
            "bio": "<string>",
            "businessGroup": "<string>",
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "email": "<string>",
            "firstName": "<string>",
            "groupsJson": "<string>",
            "id": "<string>",
            "image": "<string>",
            "isExternallyManaged": true,
            "lastName": "<string>",
            "preferences": {
              "showOnboarding": true,
              "showScrollbars": true,
              "showWelcomeMessage": true
            },
            "rolesJson": "<string>",
            "searchText": "<string>",
            "security": {
              "roles": [
                "<string>"
              ]
            },
            "showDeveloperTools": true,
            "title": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "userStorage": {
              "favoriteLinks": [
                {
                  "link": "<string>"
                }
              ]
            },
            "userType": "<string>",
            "uuid": "<string>"
          },
          "ownerId": "<string>",
          "projectTemplateRef": "<string>",
          "searchText": "<string>",
          "slug": "invoice-processing",
          "status": {
            "changeSequence": 123,
            "color": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "icon": "<string>",
            "id": "<string>",
            "organization": {
              "authGroupLink": {
                "authGroup": "<string>"
              },
              "changeSequence": 123,
              "createdOn": "2023-11-07T05:31:56Z",
              "defaultToPrivateTemplates": true,
              "description": "Document processing organization for Acme Corp.",
              "enterpriseOrganization": true,
              "features": {},
              "hasImage": true,
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "memory": {
                "orderedDashboards": [
                  "<string>"
                ]
              },
              "name": "Acme Corp",
              "organizationStatus": "ACTIVE",
              "properties": {},
              "publicAccess": true,
              "searchText": "<string>",
              "slug": "acme-corp",
              "stripeCustomerId": "<string>",
              "supportAccess": true,
              "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "uuid": "550e8400e29b41d4a716446655440000"
            },
            "organizationId": "<string>",
            "production": true,
            "status": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "statusId": "<string>",
          "statusType": "ACTIVE",
          "templateArticleId": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "7c9e667974254de944be07fc1f90ae7"
        },
        "projectId": "<string>",
        "properties": {},
        "schedules": [
          {
            "changeSequence": 123,
            "createdOn": "2023-11-07T05:31:56Z",
            "cronExpression": "<string>",
            "id": "<string>",
            "lastEvent": "2023-11-07T05:31:56Z",
            "nextEvent": "2023-11-07T05:31:56Z",
            "type": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          }
        ],
        "searchText": "<string>",
        "slug": "daily-invoice-processing",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "scheduledJobId": "<string>",
      "startTime": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "userCancelled": true,
      "uuid": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of ScheduledJobExecution

Paginated response containing ScheduledJobExecution items.

​
content
object[]

Array of ScheduledJobExecution items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.