API Reference

Searches affiliate-account composites, accepting the criteria in the request body.

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

Functionally identical to GET /composites/accounts but takes the same
AffiliateAccountCompositeRequest as a JSON body, which is convenient when the array filters
are large. 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 affiliate-account composites.

accountId
array of int32s | null

Optional list of account IDs to restrict the result to.

accountId
affiliateId
array of int32s | null

Optional list of affiliate (tenant) IDs to filter by.

affiliateId
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 account statuses to filter by.

status
affiliateStatus
array of objects | null

Optional list of affiliate statuses to filter by.

affiliateStatus
string | null

Represents the property used to specify a search or filtering term in queries.
Accepts a string value that is compared against various fields for partial or case-insensitive matches.
Intended for use in narrowing down query results by matching the specified term against relevant textual fields.

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

Represents the property used to specify the sorting criteria for the query.
Accepts a comma-separated list of sorting parameters.
Each parameter can be prefixed with "+" for ascending order or "-" for descending order.
If not specified, a default sorting order is applied.

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