List products

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/products

List all products with pagination and filtering.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Query Parameters

page

Page

integer

default: 1 >= 1

page_size

Page Size

integer

default: 20 >= 1 <= 100

search

Any of:

string

string

null

null

Search by name, SKU, or description

item_type

Any of:

string

string

null

null

Filter by item type (good, service)

is_active

Any of:

boolean

boolean

null

null

sort_by

Any of:

string

string

null

null

sort_order

Any of:

string

string

/^(asc|desc)$/

null

null

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

200 response example

{
  "status": "ok",
  "message": "Request completed successfully."
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}