Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
w) Scheduled Jobs

List scheduled jobs for a tenant

Returns a list of scheduled jobs, optionally filtered by related entity type, related entity ID, job type, and date range.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/scheduled-jobs

Path parameters

tenantIdinteger required

Query parameters

dateFilterOnstring

Column to apply the date range to. Use 'StartDate' for the job start date, 'EndDate' for the end date; leave empty to filter on created date.

dateFromInclstring

Start of the date range (inclusive). ISO date string.

dateToInclstring

End of the date range (inclusive). ISO date string.

limitinteger
offsetinteger
relatedToIdstring

Related entity ID value to filter by.

relatedToTypestring

Related entity type to filter by, e.g. walletId, customerId.

type'BATCH_WITHDRAWAL' | 'RECURRING_PAYMENT' | 'RECURRING_WITHDRAWAL'

Filter by job type.

Response

OK

cronstring
cronTimezonestring
descriptionstring
endDatestring date-time
scheduledJobIdinteger

A unique system generated numeric identifier for the scheduledJob

startDatestring date-time
tenantIdinteger
type'BATCH_WITHDRAWAL' | 'RECURRING_PAYMENT' | 'RECURRING_WITHDRAWAL'

Example response

[
  {
    "endDate": "2022-03-10T12:15:50-04:00",
    "startDate": "2022-03-10T12:15:50-04:00"
  }
]