inventory/category/get - Equotix One API

This returns the list of categories available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

category_id

integer

optional

The category ID to search for specifically.

filter_name

string

optional

Filter the list of categories by name.

filter_date_modified

string

optional

Filter the list of categories modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of categories to include deleted records.

filter_channel_group_id

string

optional

The channel group ID to search for, comma separated for multiple channel group IDs.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "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

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available.

categories

array [object {8}]

optional

The list of categories.

category_id

integer

required

The category ID.

parent_id

integer

required

The parent category ID.

channel_group_id

integer

required

The channel group ID assigned.

name

string

required

The full category path name.

image

string

required

The category image URL.

category_name

string

required

The category name.

date_modified

string

required

The date time this category was last modified.

deleted

boolean

optional

Indicates if the category has been deleted. Only returned if filter_deleted is "1".

Example

{
    "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
        }
    ]
}