API Reference

Lists catalog brands matching the supplied search criteria.

get
https://platform.routy.app/api/v1/brands

Filters: id, program-id and vertical-id arrays, status (New, Enabled, Closed) and free-text
term. Set my=true to restrict to brands the caller has at least one link for.
Paginate with offset (0-based) and limit; order with sort.
Requires the CatalogRead policy.

🔐 Required permission: catalog.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
Id
array of int32s

Restrict to these brand ids.

Id
ProgramId
array of int32s

Restrict to brands associated with any of these affiliate program ids.

ProgramId
VerticalId
array of int32s

Restrict to brands tagged with any of these vertical ids.

VerticalId
Status
array of objects

Restrict to brands in any of these statuses (New, Enabled, Closed).

Status
Allowed:
string

Free-text search term (matched against the brand name and related fields).

int32

Maximum number of items to return (page size).

int32

Number of items to skip (0-based offset for pagination).

boolean

When true, restrict to brands the calling affiliate has at least one link for.

string

Sort expression (column name; may be prefixed to indicate descending order).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago