Skip to main content
GET
Get ScheduledJob by ID

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The ScheduledJob

A scheduled job automates document processing on a recurring basis.

active
boolean | null
changeSequence
integer<int32>

Optimistic locking version number.

createdOn
string<date-time>

Timestamp when the scheduled job was created.

deleted
boolean
description
string
id
string

Unique identifier (UUID) for the scheduled job.

Example:

"f5678901-23ab-cdef-4567-890123abcdef"

modelRef
string
name
string

Display name of the scheduled job.

Example:

"Daily Invoice Processing"

project
object | null

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

projectId
string | null
properties
object
schedules
object[]
searchText
string
slug
string

URL-friendly identifier for the scheduled job.

Example:

"daily-invoice-processing"

updatedOn
string<date-time>

Timestamp when the scheduled job was last updated.

uuid
string

Secondary UUID identifier.