Skip to main content
GET
cURL

Authorizations

​
Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

​
page
integer<int32>
default:1

1-based page number for paginated results. Default is usually 1. Combine with size to page through large result sets.

Required range: x >= 1
Example:

1

​
size
integer<int32>
default:100

Number of results to return per page. Keep requests within published API page-size limits; oversized values may be capped by the server.

Required range: 1 <= x <= 100
Example:

100

​
code
string

Exact or prefix code filter (for example region or category code).

​
name
string

Case-insensitive name filter for matching resources.

​
active
boolean
default:true

When set, filter to active (true) or inactive (false) resources.

Response

Paginated list of categories

Standard paginated response wrapper used by all list endpoints. Use pageNumber and size to paginate; stop when pageNumber >= totalPages.

​
size
integer<int32>
required

Maximum number of items per page as requested

Example:

10

​
totalElements
integer<int64>
required

Total number of items matching the query across all pages

Example:

42

​
totalPages
integer<int32>
required

Total number of pages based on totalElements / size

Example:

5

​
pageNumber
integer<int32>
required

Current page number, 1-based (first page = 1)

Example:

1

​
data
any[]
required

Items in the current page; may be fewer than size on the last page