Skip to content
Topsort Documentation
API

Get Category

GET
/v1/catalog-search-service/catalogs/categories/{category-id}

Get category by ID.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Path Parameters

object
category-id
required

The ID of the category to retrieve.

string
>= 1 characters

The ID of the category to retrieve.

Responses

Successful Response

A category is a division for products within a marketplace catalog. Categories may be organized into hierarchies.

application/json
object
id
required

The category ID. If there is no ID for categories in the marketplace, this can be the category name as long as it is unique.

string
>= 1 characters
name
required

The category name.

string
>= 1 characters
parentId

The ID of the parent category. This model assumes each category can at most one parent category. In this example, bneEmHKG2yUe could be a reference to the Beers category.

string
>= 1 characters