API Reference

Returns a paginated list of brand links matching the supplied search criteria.

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

Requires the ListAccount policy. Paginate with Offset (0-based) and Limit.

🔐 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. Restricts results to these brand-link ids.

Id
AffiliateId
array of int32s

Optional. Restricts results to these affiliate ids.

AffiliateId
ProgramId
array of int32s

Optional. Restricts results to these affiliate-program ids.

ProgramId
SoftwareId
array of int32s

Optional. Restricts results to these software (platform) ids.

SoftwareId
AccountId
array of int32s

Optional. Restricts results to these Routy internal account ids.

AccountId
BrandId
array of int32s

Optional. Restricts results to these brand ids. Note: Platform.Models.BrandLinks.BrandLinkSearchCriteria.BrandIds is a separate field on this type.

BrandId
OfferId
array of int32s

Optional. Restricts results to these offer ids.

OfferId
Statuses
array of objects

Optional. Restricts results to brand links in these statuses. See Platform.Models.BrandLinks.BrandLinkStatus.

Statuses
Allowed:
string
enum

Whether archived links are included. Defaults to Platform.Models.Archiving.ArchiveFilter.Active
(archived links hidden from the main list). Archiving does not affect traffic.

Allowed:
BrandIds
array of int32s

Optional. Restricts results to these brand ids. Note: distinct from Platform.Models.BrandLinks.BrandLinkSearchCriteria.BrandId.

BrandIds
string

Optional. Free-text search term applied across name-like fields.

string

Optional. Name of the field to sort by.

int32

Optional. Maximum number of items to return.

int32

Optional. Number of items to skip (0-based).

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