List Scheduled Jobs

Retrieves all scheduled jobs for an application with pagination and optional date range filtering. Supports filtering by execution date range.

GET/api/v1/{team_slug}/{app_slug}/schedule
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/schedule

Retrieves all scheduled jobs for an application with pagination and optional date range filtering. Supports filtering by execution date range.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/schedule
  • Summary: List Scheduled Jobs
  • Description: Retrieves all scheduled jobs for an application with pagination and optional date range filtering. Supports filtering by execution date range.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters7 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
pagequeryNointegerPage number (default is 1)
per-pagequeryNointegerAmount of jobs per page. Minimum 1 and max 100 (default is 20)
from-datequeryNostringInclude jobs with execute_at >= this RFC3339 timestamp
to-datequeryNostringInclude jobs with execute_at <= this RFC3339 timestamp
item-idsqueryNostring[]Filter jobs by item IDs (can be specified multiple times)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200Scheduled jobsapplication/json (object)
400Invalid request (e.g. bad query params)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Scheduling List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Job
PropertyTypeRequiredDetails
add_category_namesstring[]No-
add_collection_namesstring[]No-
add_tag_namesstring[]No-
execute_atstringNoDate when the job should run
finished_atstringNoIf a job is finished will this timestamp be filled
idstringNo-
item_idstringNo-
item_namestringNo-
item_typestringNo-
remove_category_namesstring[]No-
remove_collection_namesstring[]No-
remove_tag_namesstring[]No-
to_amount_cents_with_taxintegerNo-
to_market_idstringNo-
to_market_statusstringNo-
to_on_salebooleanNo-
to_sale_amount_cents_with_taxintegerNo-
to_start_sale_timestampstringNo-
to_statusstringNo-
to_stop_sale_timestampstringNo-
to_store_group_idstringNo-
{
  "data": [
    {
      "add_category_names": [
        "string"
      ],
      "add_collection_names": [
        "string"
      ],
      "add_tag_names": [
        "string"
      ],
      "execute_at": "string",
      "finished_at": "string",
      "id": "string",
      "item_id": "string",
      "item_name": "string",
      "item_type": "string",
      "remove_category_names": [
        "string"
      ],
      "remove_collection_names": [
        "string"
      ],
      "remove_tag_names": [
        "string"
      ],
      "to_amount_cents_with_tax": 0,
      "to_market_id": "string",
      "to_market_status": "string",
      "to_on_sale": false,
      "to_sale_amount_cents_with_tax": 0,
      "to_start_sale_timestamp": "string",
      "to_status": "string",
      "to_stop_sale_timestamp": "string",
      "to_store_group_id": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/schedule
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Scheduling
  • OpenAPI summary: List Scheduled Jobs

List Scheduled Jobs

# List Scheduled Jobs Retrieves all scheduled jobs for an application with pagination and optional date range filtering. Supports filtering by execution date range.
GET /api/v1/{team_slug}/{app_slug}/schedule
Purpose

Retrieves all scheduled jobs for an application with pagination and optional date range filtering.

Required inputs

app_slug path team_slug path

Primary response

200 ยท Scheduled jobs

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/schedule

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/schedule` - Summary: List Scheduled Jobs - Description: Retrieves all scheduled jobs for an application with pagination and optional date range filtering. Supports filtering by execution date range. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/schedule` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | page | query | No | integer | Page number (default is 1) | | per-page | query | No | integer | Amount of jobs per page. Minimum 1 and max 100 (default is 20) | | from-date | query | No | string | Include jobs with execute_at >= this RFC3339 timestamp | | to-date | query | No | string | Include jobs with execute_at <= this RFC3339 timestamp | | item-ids | query | No | string[] | Filter jobs by item IDs (can be specified multiple times) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Scheduled jobs | application/json (object) | | 400 | Invalid request (e.g. bad query params) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Scheduling List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Job | Property | Type | Required | Details | | --- | --- | --- | --- | | `add_category_names` | string[] | No | - | | `add_collection_names` | string[] | No | - | | `add_tag_names` | string[] | No | - | | `execute_at` | string | No | Date when the job should run | | `finished_at` | string | No | If a job is finished will this timestamp be filled | | `id` | string | No | - | | `item_id` | string | No | - | | `item_name` | string | No | - | | `item_type` | string | No | - | | `remove_category_names` | string[] | No | - | | `remove_collection_names` | string[] | No | - | | `remove_tag_names` | string[] | No | - | | `to_amount_cents_with_tax` | integer | No | - | | `to_market_id` | string | No | - | | `to_market_status` | string | No | - | | `to_on_sale` | boolean | No | - | | `to_sale_amount_cents_with_tax` | integer | No | - | | `to_start_sale_timestamp` | string | No | - | | `to_status` | string | No | - | | `to_stop_sale_timestamp` | string | No | - | | `to_store_group_id` | string | No | - |
Generated example (synthetic) ```json { "data": [ { "add_category_names": [ "string" ], "add_collection_names": [ "string" ], "add_tag_names": [ "string" ], "execute_at": "string", "finished_at": "string", "id": "string", "item_id": "string", "item_name": "string", "item_type": "string", "remove_category_names": [ "string" ], "remove_collection_names": [ "string" ], "remove_tag_names": [ "string" ], "to_amount_cents_with_tax": 0, "to_market_id": "string", "to_market_status": "string", "to_on_sale": false, "to_sale_amount_cents_with_tax": 0, "to_start_sale_timestamp": "string", "to_status": "string", "to_stop_sale_timestamp": "string", "to_store_group_id": "string" } ], "success": false, "total": 0, "total_pages": 0 } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/schedule` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/schedule` - OpenAPI tag: Scheduling - OpenAPI summary: List Scheduled Jobs