API Reference

Searches affiliate programs using the same criteria as the GET listing, supplied in the request body.

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

Functionally identical to GET /affiliate-programs but accepts the criteria as a JSON body,
which is convenient when sending large filter arrays. See the GET endpoint for the full list of
supported filters and pagination (offset/limit). Requires the CatalogRead policy.

🔐 Required permission: catalog.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter, sort and pagination criteria.

Filter, sort and pagination criteria for listing affiliate programs. All filters are optional and
are combined with AND semantics; array filters match any of the supplied values.

id
array of int32s | null

Restrict to these affiliate program ids.

id
brandId
array of int32s | null

Restrict to programs associated with any of these brand ids.

brandId
softwareId
array of int32s | null

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

softwareId
verticalId
array of int32s | null

Restrict to programs tagged with any of these vertical ids.

verticalId
affiliateId
array of int32s | null

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

affiliateId
statuses
array of objects | null

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

statuses
Allowed:
string | null

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

int32 | null

Maximum number of items to return (page size).

int32 | null

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

date-time | null

Restrict to programs created at or after this UTC timestamp.

date-time | null

Restrict to programs updated at or after this UTC timestamp.

boolean | null

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

string | null

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:
string
enum
Defaults to application/json

Generated from available request 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