Qodex.ai

List products

GET {{baseUrl}}/api/v1/products

This API lists a specific number of products from your help desk portal, based on the limit defined. (Note: The departmentIds key will soon be deprecated and not included in API responses.)

OAuth Scope

  • Desk.products.READ
  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
viewIdstringID of the view to apply while fetching the products
fromstringIndex number, starting from which the products must be fetched
limitstringNo. of products to fetch
departmentIdsstringThis key will soon be deprecated from both API requests and responses. Please replace it with the departmentId key in your code.
departmentIdstringID of the department from which the products must be fetched. If you want to list the products configured in all accessible departments, pass the value 0.
ownerIdstringID of user to whom the product is assigned
sortBystringSort by a specific attribute : productName, productCode, unitPrice, createdTime or modifiedTime. The default sorting order is ascending. A - prefix denotes descending order of sorting.
fieldsstringKey that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: layoutId. Maximum of 30 fields is supported as comma separated values.
includestringSecondary information related to the contact.Value supported is owner.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"unitPrice":"100.0","productCode":null,"id":"6000000121033","departmentIds":["6000000007239","6000000029263"],"productName":"HTC"},{"unitPrice":"100.0","productCode":null,"id":"6000000121037","departmentIds":["6000000007239","6000000029263"],"productName":"Dell"},{"unitPrice":"100.0","productCode":null,"id":"6000000145024","departmentIds":["6000000007239","6000000029263"],"productName":"Lenovo"}]}