API Reference

Lists affiliate program software matching the supplied search criteria.

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

Filters: id and affiliate id arrays, the program-id array (sent on the query string as
programId), free-text term, and status (New, Enabled, Closed). Set
my=true to restrict to software 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 software ids.

Id
AffiliateId
array of int32s

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

AffiliateId
AffiliateProgramId
array of int32s

Restrict to software backing any of these affiliate program ids. Sent on the wire as
programId.

AffiliateProgramId
string

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

string

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

boolean

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

int32

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

int32

Maximum number of items to return (page size).

Status
array of objects

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

Status
Allowed:
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