API Reference

Retrieves a paginated list of commission-plan composites matching the supplied filters.

get
https://platform.routy.app/api/v1/composites/accounts/commission-plans

Filter by id, account, program, software, brand, status and free-text term. Paginate with
offset (0-based) and limit; sort with sortBy + sortDirection. Scoped to
the calling affiliate; admin tokens see all affiliates. Requires the ListAccount policy.
This is the query-string variant of POST /composites/accounts/commission-plans/search.

🔐 Required permission: accounts.read

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

Optional list of commission-plan IDs to restrict the result to.

Id
AccountId
array of int32s

Optional list of account IDs to filter by.

AccountId
AffiliateProgramId
array of int32s

Optional list of affiliate-program IDs to filter by.

AffiliateProgramId
SoftwareId
array of int32s

Optional list of tracking-software IDs to filter by.

SoftwareId
BrandId
array of int32s

Optional list of brand IDs to filter by.

BrandId
Status
array of objects

Optional list of commission-plan statuses to filter by.

Status
Allowed:
string

Optional free-text term matched (case-insensitively) against the plan name/description.

int32

Zero-based number of records to skip for pagination. Defaults to 0 when omitted.

int32

Maximum number of records to return for pagination.

string

Optional sort expression: a comma-separated list of fields, each prefixed with
+ for ascending or - for descending (e.g. -name,+id). A field
with no prefix sorts ascending.

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