1. Home
  2. Docs
  3. Mavryx API Endpoints
  4. Vista Dev
  5. [GET] /api/product/list

[GET] /api/product/list

Returns a list of products that the logged-in account has access to.

Query parameters

Field NameTypeDescription
qMavryx/Types/StringQuery
a[]Mavryx/Types/ArrayArguments
sort[]Mavryx/Types/ArraySort
startMavryx/Types/IntegerStart from
limitMavryx/Types/IntegerHow many items to return (default: 50)

Example response

{
  "header": {
    "version": 20240101,
    "endpoint": "/api/product/list",
    "referer": "https://swagger-dev.mavryx.software",
    "raycast": "5d06f2af11af3b71ddae73a827fbc32d",
    "request_id": "0bffb5478ea1f203e1ec75b1a138e905",
    "response_id": "b474beeb6f8d8226fd487a71d362ebef",
    "status": 200,
    "message": "OK"
  },
  "response": {
    "response_type": "list",
    "type": "Mavryx/Product",
    "items_count": 1,
    "filtered_count": 1,
    "total_count": 123,            
    "list": [
      {
        "uuid": "069aa47b-1dd8-4273-8dsa-1b4dadea8ff4",
        "type": "Mavryx/Product",
        "created_time": 1571156658,
        "updated_time": null,
        "deleted_time": null,
        "owner_account_uuid": "069aa47b-1dd8-1234-eeee-1b4dadea8ff4",
        "organisation_uuid": "069aa47b-efef-eede-eeee-1b4dadea8ff4",        
        "name": "Fresh Farms"
      },
    ]
  }
}
Was this article helpful to you? No Yes

How can we help?