inventory/category/get
POST/inventory/category/getThis returns the list of categories available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The category ID to search for specifically.
Filter the list of categories by name.
Filter the list of categories modified after the spcified date.
Filter the list of categories to include deleted records.
The channel group ID to search for, comma separated for multiple channel group IDs.
Page number of the results.
The key for the ordering of the results. Accepts "name", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"category_id": 0,
"filter_name": "string",
"filter_date_modified": "string",
"filter_deleted": true,
"filter_channel_group_id": "string",
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The total number of results available.
The list of categories.
The category ID.
The parent category ID.
The channel group ID assigned.
The full category path name.
The category image URL.
The category name.
The date time this category was last modified.
Indicates if the category has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"total": 0,
"categories": [
{
"category_id": 0,
"parent_id": 0,
"channel_group_id": 0,
"name": "string",
"image": "string",
"category_name": "string",
"date_modified": "string",
"deleted": true
}
]
}