API Reference

Lists affiliate programs from the global catalog matching the supplied search criteria.

get
https://platform.routy.app/api/v1/affiliate-programs

Filters can be combined: id, brand, software, vertical and affiliate id arrays, free-text
term, statuses (New, Enabled, Closed), and the addedSince/updatedSince
timestamps. Set my=true to restrict to programs the calling affiliate is associated with.
Paginate with offset (0-based) and limit. 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 affiliate program ids.

Id
BrandId
array of int32s

Restrict to programs associated with any of these brand ids.

BrandId
SoftwareId
array of int32s

Restrict to programs belonging to any of these software (platform) ids.

SoftwareId
VerticalId
array of int32s

Restrict to programs tagged with any of these vertical ids.

VerticalId
AffiliateId
array of int32s

Restrict to programs associated with any of these affiliate (account) ids.

AffiliateId
Statuses
array of objects

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

Statuses
Allowed:
string

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

int32

Maximum number of items to return (page size).

int32

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

date-time

Restrict to programs created at or after this UTC timestamp.

date-time

Restrict to programs updated at or after this UTC timestamp.

boolean

When true, restrict to programs the calling affiliate is associated with.

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