List Product Drafts

Retrieves a paginated list of all product drafts for the current app, including draft metadata, changeset summaries, and scheduled publication times.

GET/api/v1/{team_slug}/{app_slug}/drafts

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

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

Retrieves a paginated list of all product drafts for the current app, including draft metadata, changeset summaries, and scheduled publication times.

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\}/drafts
Summary: List Product Drafts
Description: Retrieves a paginated list of all product drafts for the current app, including draft metadata, changeset summaries, and scheduled publication times.
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.

Parameters4 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
per-page	query	No	integer	Items per page

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses

Status	Description	Content
200	Drafts retrieved successfully	application/json (object)
401	Unauthorized access	application/json (object)
500	Internal server error	application/json (object)

200 - object

Product Draft List

Property	Type	Required	Details
`data`	object[]	No	-
`success`	boolean	No	-
`total`	integer	No	-
`total_pages`	integer	No	-

Product Draft

Property	Type	Required	Details
`app_id`	string	No	-
`changeset`	object	No	-
`created_at`	string	No	-
`id`	string	No	-
`product_id`	string	No	-
`publish_at`	string	No	-
`updated_at`	string	No	-

Product Draft Changeset

Property	Type	Required	Details
`attributes`	string[]	No	-
`categories`	object[]	No	-
`collections`	string[]	No	-
`description`	string	No	-
`html_description`	string	No	-
`html_short_description`	string	No	-
`images`	object[]	No	-
`meta_description`	string	No	-
`meta_title`	string	No	-
`name`	string	No	-
`short_description`	string	No	-
`tags`	object[]	No	-

Generated example (synthetic):

{
  "data": [
    {
      "app_id": "string",
      "changeset": {
        "attributes": [],
        "categories": [],
        "collections": [],
        "description": "string",
        "html_description": "string",
        "html_short_description": "string",
        "images": [],
        "meta_description": "string",
        "meta_title": "string",
        "name": "string",
        "short_description": "string",
        "tags": []
      },
      "created_at": "string",
      "id": "string",
      "product_id": "string",
      "publish_at": "string",
      "updated_at": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "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):

{
  "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\}/drafts
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Product Drafts
OpenAPI summary: List Product Drafts