GET Category by searching in category names
GEThttps://instancename.piminto.com/api/en-us/v/ct/:searchWord
- Requires Data Viewer ApiKey permissions.
- Example URI: https://instancename.piminto.com/api/en-us/v/ct/searchWord
Provides the ability to get a list of categories that contain the specified search term (search word or phrase) in their names.
Returns
Specify a search term (word or phrase) and the endpoint will return information about categories that contain the specified search term in their names.
If no category matches the query, the resulting response contains only: "status" = "OK", indicating that the request was successfully sent and executed.
This API call provides a flexible way to search for categories in your PIMS and can be useful when you need to find categories that meet certain search criteria, such as identifying all categories related to a particular product line.
Request
Path Parameters
Search word or phrase in category name
Responses
- 200
success
- application/json
- Schema
- Example (from schema)
Schema
- Categories
- Category not found
The status of the API request. A value of "OK" indicates that the request was successfully sent and processed.
categoriesTree object[]required
{}
Authorization: ApiKey
name: ApiKeytype: apiKeyin: header
- curl
- python
- nodejs
- php
- java
- CURL
curl -L -X GET 'https://instancename.piminto.com/api/en-us/v/ct/:searchWord' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>'