API Reference

Searches commission-plan composites, accepting the criteria in the request body.

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

Functionally identical to GET /composites/accounts/commission-plans but takes the
CommissionPlanCompositeRequest as a JSON body. Paginate with offset/limit.
Scoped to the calling affiliate; admin tokens see all affiliates. Requires the ListAccount
policy.

🔐 Required permission: accounts.read

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

Filtering, sorting and pagination criteria.

Filtering, sorting and pagination criteria for listing/searching commission-plan composites.

id
array of int32s | null

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

id
accountId
array of int32s | null

Optional list of account IDs to filter by.

accountId
affiliateProgramId
array of int32s | null

Optional list of affiliate-program IDs to filter by.

affiliateProgramId
softwareId
array of int32s | null

Optional list of tracking-software IDs to filter by.

softwareId
brandId
array of int32s | null

Optional list of brand IDs to filter by.

brandId
status
array of objects | null

Optional list of commission-plan statuses to filter by.

status
Allowed:
string | null

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

int32 | null

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

int32 | null

Maximum number of records to return for pagination.

string | null

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