API Reference

Retrieves a paginated list of affiliate-account composites matching the supplied filters.

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

Each row joins the account with its affiliate, program, network, software, default commission plan,
brands and integration status. Filter by account, affiliate, program, software, brand, status and
free-text term. Paginate with offset (0-based) and limit; sort with sortBy
(comma-separated, +/- prefix per field). Scoped to the calling affiliate; admin
tokens see all affiliates. Requires the ListAccount policy.

This is the query-string variant of POST /composites/accounts/search, which accepts the
same criteria in the request body.

🔐 Required permission: accounts.read

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

Optional list of account IDs to restrict the result to.

AccountId
AffiliateId
array of int32s

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

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

Status
AffiliateStatus
array of objects

Optional list of affiliate statuses to filter by.

AffiliateStatus
string

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

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

int32

Maximum number of records to return for pagination.

string

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