Skip to main content
GET
Get the agency's five highest-spending fans
Required scopes
  • read:agency — Read agency information, including the agency’s team members.
  • read:creator — Access creator profiles, content, and creator-specific information.
  • read:fan — Access fan-related data and information within the platform.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Query Parameters

startDate
string<date-time>
required

Start of the date range (inclusive). UTC ISO 8601 datetime with offset.

endDate
string<date-time>
required

End of the date range (exclusive). UTC ISO 8601 datetime with offset.

creatorUuids
string<uuid>[]

Comma-separated list of creator UUIDs to restrict results to a subset of the agency's managed creators (max 50). Every uuid must belong to the agency: one that does not fails the whole request with 403 rather than being ignored. Comma-separated list of creator UUIDs (max 50)

Maximum array length: 50
earningsView
enum<string>
default:gross

Which earnings figure to rank by. Both figures are returned on every row regardless.

Available options:
net,
gross

Response

The agency's five highest-spending fans

data
object[]
required

Highest-spending fans, best first, at most five rows