Skip to main content
GET
List Categories

Query Parameters

page_size
integer
default:20

Number of results per page

Required range: 1 <= x <= 100
page_number
integer
default:1

Page number

Required range: x >= 1
search_query
string

Search term for category names

activeOnly
boolean
default:false

Filter to only active categories

Response

200 - application/json

Categories retrieved successfully

message
string
required
Example:

"Categories fetched successfully"

category
enum<string>
required
Available options:
SUCCESS
Example:

"SUCCESS"

data
object[]
required
rc_hit
boolean

Indicates if the response was served from cache

Example:

false

rc_key
string

Cache key used for this response

Example:

"categories:abc123"

metadata
object

Pagination metadata