GET
/
api-category
/
v1
/
category
/
search

Authorizations

Authorization
string
header
required

S2S access token (JWT) from fabric Identity service (during Login)

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

keyword
string

Keywords to search for categories. The response is paginated. Using query parameters page and size, you can narrow down the search results.

ids
string[]

A 24-characters system-generated category IDs. If ids and nodeIds are omitted, this endpoint returns a paginated response. Using query parameters page and size, you can narrow down the search results.

nodeIds
number[]

Numeric category IDs. If ids and nodeIds are omitted, this endpoint returns a paginated response. Using query parameters page and size, you can narrow down the search results.

type
enum<string>

Category type. <br /> Note: If omitted, you will get a paginated response with ALL categories. Using query parameters page and size, you can narrow down the search results.

Available options:
PRIMARY,
ALTERNATE,
ALL
status
enum<string>

Category status. If omitted, you will get a paginated response of categories in ACTIVE status. Using the query parameters page and size, you can narrow down the search results. <br /> Note: When type is Primary, status must be Active. Inactive status is not applicable for Primary category.

Available options:
ACTIVE,
INACTIVE,
ALL
page
number

Page number to be retrieved. <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with size <br /> 3) No default value set. Unless a value is specified, endpoint returns an error.

size
number

Number of records per page <br /> Note: <br /> 1) Always paired with page. <br /> 2) Applicable only in a paginated response. <br /> 3) No default value set. Unless a value is specified, endpoint returns an error.

Response

200 - application/json
totalSize
number

Total number of records (categories)

pageSize
number

Number of records (categories) per page

pages
number

Number of pages for the given pageSize

categories
object[]