Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
schedule
Error
A valid request URL is required to generate request examples
{
  "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": 123,
      "to_market_id": "<string>",
      "to_market_status": "<string>",
      "to_on_sale": true,
      "to_sale_amount_cents_with_tax": 123,
      "to_start_sale_timestamp": "<string>",
      "to_status": "<string>",
      "to_stop_sale_timestamp": "<string>",
      "to_store_group_id": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
page
integer

Page number (default is 1)

​
per-page
integer

Amount of jobs per page. Minimum 1 and max 100 (default is 20)

​
from-date
string

Include jobs with execute_at >= this RFC3339 timestamp

​
to-date
string

Include jobs with execute_at <= this RFC3339 timestamp

​
item-ids
string[]

Filter jobs by item IDs (can be specified multiple times)

Response

Scheduled jobs

​
data
object[]
​
success
boolean
​
total
integer
​
total_pages
integer