Skip to main content
GET
/
public
/
v1
/
catalog-search-service
/
catalogs
/
categories
Get Categories
curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "response": [
    {
      "globalId": "CAT-12345",
      "id": "ahEDqV5uhjj8",
      "metadata": {
        "associatedProducts": 100,
        "description": "All drinks available in the marketplace.",
        "globalName": "Beers",
        "path": "Driks/Alcoholic/Beers",
        "showInStore": true
      },
      "name": "Beers/Belgian",
      "parentId": "bneEmHKG2yUe"
    }
  ]
}

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

next_page
string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

Response

Successful Response

hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

response
Category · object[]
required

Array of categories. Empty when the catalog contains no categories.

nextPage
string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="

I