Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page
integer

1-based page number to return. Defaults to 1.

Required range: 0 < x <= 9007199254740991
pageSize
integer

Rows per page, 1..100. Defaults to 20.

Required range: 0 < x <= 100
country
string

Filter to brands whose country of origin matches.

Minimum string length: 1
active
enum<string>

Filter by the active flag: true (live only), false (archived only). Both when omitted.

Available options:
true,
false
sortField
enum<string>

Field to order by: name or code. Unsorted when omitted.

Available options:
name,
code
sortDirection
enum<string>

Sort direction; defaults to asc when sortField is set.

Available options:
asc,
desc

Response

A page of brand directory rows with the pagination totals.

A page of brand directory rows with the pagination totals.

items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageSize
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pageCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991