List Products
Retrieve all products and services for the authenticated team.
Header Parameters
x-client-idstring
x-signaturestring
Authorizationstring
Query Parameters
searchstring
Search products by name or code
pageinteger
Default value
1
limitinteger
Default value
50
statusstring
Enum values:
activeinactiveResponse
200
Object
{
"status": "success",
"results": 25,
"message": {
"products": [
{
"uuid": "75dd724b-c01d-4e75-91db-86675cd7f563",
"name": "Junk Removal - Service",
"code": "JUNK-001",
"description": "Professional junk removal service",
"unitPrice": 250.00,
"currency": "USD",
"tax": 0,
"status": "active",
"pricingMethod": "item",
"categoryAccount": {
"name": "Product Sales",
"type": "Revenue"
}
},
{
"uuid": "a8f2e4c1-9b3d-4e7a-8c2f-1d5b6e9a0f3c",
"name": "Tips - Received",
"description": "Thank you!",
"unitPrice": 0,
"currency": "USD",
"tax": 0,
"status": "active",
"pricingMethod": "item"
}
],
"totalRecords": 25,
"limit": 50,
"page": 1,
"orderBy": "name",
"orderDirection": "ASC"
}
}
Response Attributes
statusstring
resultsinteger
messageobject
Show child attributes
401
Object
Unauthorized - Authentication failed
Response Attributes
statusstring Required
Always "error" for error responses
messagestring Required
Human-readable error description
codestring Required
Machine-readable error code for programmatic handling
detailsobject
Additional context about the error (varies by error type)
Show child attributes
errorsarray
Present for validation errors with multiple fields
Show child attributes
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?