List products

Lists products for a project extension, including draft products unless the request filters them out.

GETPOST PUT DELETE

Authentication

Requirement: Required
Credential type: Bearer API key
Scopes: Not specified

Permissions

API-key requests must use a key with an active connection to the target project.

Headers

Name	Required	Type	Details
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.

Path Parameters

Name	Required	Type	Details
`project_id`	Yes	Not specified	Description: Target project identifier.

Query Parameters

Name	Required	Type	Details
`page`	No	integer	Description: Page number. Defaults to 1. Range: min 1
`page_size`	No	integer	Description: Number of products returned per page. Product management listing clamps this value. Range: min 1, max 200
`q`	No	string	Description: Search text used by this operation.
`sort`	No	string	Description: Product sort field. Unknown values fall back to position. Allowed values: `positionnameproduct_namepricebrand` Aliases: `sort_byproduct_list_order`
`direction`	No	string	Description: Sort direction. Defaults to descending for position and ascending for other product fields. Allowed values: `ascascendingdescdescending` Aliases: `dirsort_dirproduct_list_dir`
`include_drafts`	No	boolean	Description: When true, draft products can be included in the listing.
`filters`	No	object<string,array<string>>	Description: Filter map keyed by product attribute code. Use system keys for category/price filters, or replace an attribute key with a real product attribute code such as color, size, or brand. Object shape: `category` array<string>`category_slug` array<string>`price` array<number\|string>`price__min` array<number\|string>`price__max` array<number\|string>`color` array<string> example attribute key`size` array<string> example attribute key

Request Body

This operation does not accept a request body.

Response Body

Example 200 response

json

{
  "items": [],
  "total": 1
}

Errors

Operation-specific error responses are not available in the current release metadata.

Availability

Available in: v0.1.0
Available since: v0.1.0
Implementation: Available
Deprecation: Not specified
Rate limits: Not specified

Example request

GET/api/projects/{project_id}/extensions/2/products

Base URLhttps://api.modusell.com

curl --request GET \
  --url "https://api.modusell.com/api/projects/example_project_id/extensions/2/products?page=VALUE&page_size=VALUE&q=VALUE&sort=VALUE" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

Examples are not available for this release.

Authentication

Required: Bearer API key.