List Products
curl --request GET \
--url https://qwoty.app/api/products \
--header 'Authorization: <authorization>'{
"total": 42,
"next": "https://qwoty.app/api/products?limit=30&page=2",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"product_parent_id": "660e8400-e29b-41d4-a716-446655440001",
"workspace_id": "880e8400-e29b-41d4-a716-446655440003",
"name": "Consulting Services - Senior",
"api_name": "consulting_services_senior",
"reference": "SERV-001",
"description": "Senior consultant hourly rate",
"description_inherit_from_product": true,
"primary_image_inherit_from_product": true,
"is_active": true,
"is_default": true,
"catalog_ids": ["770e8400-e29b-41d4-a716-446655440002"],
"category_ids": [],
"settings": {
"unit_per_pack": 1,
"product_type": "service",
"language_id": "990e8400-e29b-41d4-a716-446655440004",
"unit_of_measure": "hour",
"recurrence_type": "recurring"
},
"shipping": {
"weight": null,
"weight_unit": null,
"height": null,
"length": null,
"width": null,
"length_unit": null,
"country_of_origin": null,
"harmonized_system_code": null
},
"inventory": {
"sku": "CONS-SEN-001"
},
"identifiers": {
"crm": null,
"accounting": null,
"erp": null
},
"accounting": {
"ledger_account": null
},
"options": [
{
"option_id": "opt-001",
"option_name": "Seniority",
"option_api_name": "seniority",
"value_id": "val-001",
"value_name": "Senior",
"value_api_name": "senior"
}
],
"prices": [
{
"id": "price-001",
"pricebook_id": "pb-001",
"pricebook_api_name": "standard"
}
],
"primary_image_id": null,
"parent_primary_image_id": null,
"created_at": "2024-12-21T10:30:00Z",
"updated_at": "2024-12-21T10:30:00Z"
}
]
}
Products
List Products
Retrieve products in your workspace with pagination and filters
GET
/
api
/
products
List Products
curl --request GET \
--url https://qwoty.app/api/products \
--header 'Authorization: <authorization>'{
"total": 42,
"next": "https://qwoty.app/api/products?limit=30&page=2",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"product_parent_id": "660e8400-e29b-41d4-a716-446655440001",
"workspace_id": "880e8400-e29b-41d4-a716-446655440003",
"name": "Consulting Services - Senior",
"api_name": "consulting_services_senior",
"reference": "SERV-001",
"description": "Senior consultant hourly rate",
"description_inherit_from_product": true,
"primary_image_inherit_from_product": true,
"is_active": true,
"is_default": true,
"catalog_ids": ["770e8400-e29b-41d4-a716-446655440002"],
"category_ids": [],
"settings": {
"unit_per_pack": 1,
"product_type": "service",
"language_id": "990e8400-e29b-41d4-a716-446655440004",
"unit_of_measure": "hour",
"recurrence_type": "recurring"
},
"shipping": {
"weight": null,
"weight_unit": null,
"height": null,
"length": null,
"width": null,
"length_unit": null,
"country_of_origin": null,
"harmonized_system_code": null
},
"inventory": {
"sku": "CONS-SEN-001"
},
"identifiers": {
"crm": null,
"accounting": null,
"erp": null
},
"accounting": {
"ledger_account": null
},
"options": [
{
"option_id": "opt-001",
"option_name": "Seniority",
"option_api_name": "seniority",
"value_id": "val-001",
"value_name": "Senior",
"value_api_name": "senior"
}
],
"prices": [
{
"id": "price-001",
"pricebook_id": "pb-001",
"pricebook_api_name": "standard"
}
],
"primary_image_id": null,
"parent_primary_image_id": null,
"created_at": "2024-12-21T10:30:00Z",
"updated_at": "2024-12-21T10:30:00Z"
}
]
}
Authorization
Bearer token for authentication. Format:
Bearer qwoty_your_tokenQuery Parameters
Number of results per page (max 200)
Page number (1-based)
Filter by external identifier. Matches against
identifiers[erp],
identifiers[crm], and identifiers[accounting].Filter by exact API name
Filter by SKU (
inventory[sku])Filter by internal reference
Examples
curl https://qwoty.app/api/products \
-H "Authorization: Bearer qwoty_your_token"
Response
Total number of products matching the query (across all pages)
URL to fetch the next page, or
null if this is the last pageArray of product objects for the current page
Show Product Object
Show Product Object
Unique identifier (UUID)
ID of parent product (UUID)
Workspace ID (UUID)
Product name (display name combining parent + variant options)
API identifier
Internal reference
Product description
Whether description is inherited from the parent product
Whether the primary image is inherited from the parent product
Active status
Whether this is the default product under its parent
Catalog IDs (UUIDs) linked to the parent product
Category IDs (UUIDs) linked to the parent product
Product settings and configuration
Shipping information
Inventory information
External system identifiers
Accounting information
Option values for this product (e.g., color, size)
UUID of the primary media for this product. Null if none is set.
UUID of the primary media of the parent product. Read-only.
{
"total": 42,
"next": "https://qwoty.app/api/products?limit=30&page=2",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"product_parent_id": "660e8400-e29b-41d4-a716-446655440001",
"workspace_id": "880e8400-e29b-41d4-a716-446655440003",
"name": "Consulting Services - Senior",
"api_name": "consulting_services_senior",
"reference": "SERV-001",
"description": "Senior consultant hourly rate",
"description_inherit_from_product": true,
"primary_image_inherit_from_product": true,
"is_active": true,
"is_default": true,
"catalog_ids": ["770e8400-e29b-41d4-a716-446655440002"],
"category_ids": [],
"settings": {
"unit_per_pack": 1,
"product_type": "service",
"language_id": "990e8400-e29b-41d4-a716-446655440004",
"unit_of_measure": "hour",
"recurrence_type": "recurring"
},
"shipping": {
"weight": null,
"weight_unit": null,
"height": null,
"length": null,
"width": null,
"length_unit": null,
"country_of_origin": null,
"harmonized_system_code": null
},
"inventory": {
"sku": "CONS-SEN-001"
},
"identifiers": {
"crm": null,
"accounting": null,
"erp": null
},
"accounting": {
"ledger_account": null
},
"options": [
{
"option_id": "opt-001",
"option_name": "Seniority",
"option_api_name": "seniority",
"value_id": "val-001",
"value_name": "Senior",
"value_api_name": "senior"
}
],
"prices": [
{
"id": "price-001",
"pricebook_id": "pb-001",
"pricebook_api_name": "standard"
}
],
"primary_image_id": null,
"parent_primary_image_id": null,
"created_at": "2024-12-21T10:30:00Z",
"updated_at": "2024-12-21T10:30:00Z"
}
]
}
Error Responses
{
"error": "Invalid API token"
}
Was this page helpful?
⌘I

