Lists the ITP participant brands.

get

https://api-sandbox-v2.openkeys.8429y94d.hml.fsapps.app/open-keys/itp/api/v2/participants/brands

Method to return the list of ITP participant brands. The return is paginated and can be filtered by brand name.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

string

length between 0 and 999999

[\s\S]*

Page number.

pageSize

string

length between 0 and 999999

[\s\S]*

Size of a page.

searchFields

string

length between 0 and 999999

[\s\S]*

Fields where to perform the search.

string

length between 0 and 999999

[\s\S]*

Value to search into the fields defined in searchFields.

apiFamilyType

string

length between 0 and 999999

[\s\S]*

Type of API family to filter the brands.

sort

string

length between 0 and 999999

[\s\S]*

Sort results by a field.

priorityIds[]

array of strings

List of priority brand IDs. Brands whose IDs are included in this list will be returned first in the results,
with higher priority in the sorting order. This is useful for highlighting preferred or featured brands.

Example usage:

priorityIds[]=brand_id_1&priorityIds[]=brand_id_2
This will return brand_id_1 and brand_id_2 first, followed by other brands

priorityIds[]

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Returns the list of brands with pagination.

401Unauthorized

403Forbidden

409Conflict

422Validation Error

500Server Error

defaultUnexpected error