> For the complete documentation index, see [llms.txt](https://api-docs.flipster.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.flipster.io/api-reference/affiliate/get-referee-info.md).

# Get Referee Info

Retrieves a paginated list of referees registered under your affiliate account.

{% hint style="warning" %}
**Note:** This endpoint is restricted to registered Flipster Affiliates. Non-affiliate accounts will receive a `400 Bad Request`
{% endhint %}

Returns a paginated list of referees who signed up under your affiliate referral code. Each record includes both the referee's `uid` and `userId`, their sign-up timestamp, their own referral code if issued, and sub-affiliate commission rate if they are a registered sub-affiliate. Providing either `uid` or `userId` as a query parameter lets you perform an exact-match lookup for a specific user.

Pagination follows the current request and response schema shown below. Use the pagination parameters defined for this endpoint to continue reading large result sets in multiple requests.

To view the referee list of a sub-affiliate, pass their referral code using the optional `referralCode` parameter. The referral code must belong to a direct sub-affiliate of the authenticated caller; otherwise a `403 Forbidden` is returned.

## Get Referee Info

> Returns a paginated list of referees under the authenticated affiliate,\
> including each referee's UID, their own referral code (if any), and\
> sub-affiliate commission rate (if they are a sub-affiliate).\
> \
> Pagination is offset-based: pass \`count\` (page size) and optional \`page\`\
> (1-indexed). When the returned \`referees\` array has fewer than \`count\`\
> entries, you have reached the last page.\
> \
> Use \`signedUpFrom\` / \`signedUpTo\` to narrow results to referees who\
> signed up within a specific time range.

```json
{"openapi":"3.0.0","info":{"title":"Prex Trading API","version":"1.0.0"},"tags":[],"servers":[{"url":"https://trading-api.flipster.io","description":"Production"}],"security":[{"thirdPartyApiKeyAuth":["read"]}],"components":{"securitySchemes":{"thirdPartyApiKeyAuth":{"description":"For third party retail API users","in":"header","name":"api-key","type":"apiKey"}},"schemas":{"Timestamp":{"title":"Timestamp","description":"Precise, high-resolution (nanosecond level) integer timestamp.","type":"string"},"Decimal":{"title":"Decimal","description":"Precise, high-resolution number type.","type":"string"},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"Error type"},"message":{"type":"string","description":"Error message"},"code":{"type":"integer","description":"Error code"}},"required":["type"]}},"required":["error"]}}},"paths":{"/api/v1/affiliate/referee-info":{"get":{"tags":["affiliate"],"summary":"Get Referee Info","description":"Returns a paginated list of referees under the authenticated affiliate,\nincluding each referee's UID, their own referral code (if any), and\nsub-affiliate commission rate (if they are a sub-affiliate).\n\nPagination is offset-based: pass `count` (page size) and optional `page`\n(1-indexed). When the returned `referees` array has fewer than `count`\nentries, you have reached the last page.\n\nUse `signedUpFrom` / `signedUpTo` to narrow results to referees who\nsigned up within a specific time range.","parameters":[{"name":"count","in":"query","schema":{"type":"integer","format":"int64","minimum":1,"maximum":100},"required":true,"description":"Number of items to return (1-100)"},{"name":"page","in":"query","schema":{"type":"integer","format":"int64","minimum":1},"description":"1-indexed page number (default 1)"},{"name":"signedUpFrom","in":"query","schema":{"$ref":"#/components/schemas/Timestamp"},"description":"Inclusive lower bound on referee signup timestamp"},{"name":"signedUpTo","in":"query","schema":{"$ref":"#/components/schemas/Timestamp"},"description":"Exclusive upper bound on referee signup timestamp"},{"name":"referralCode","in":"query","schema":{"type":"string"},"description":"Optional sub-affiliate referral code to view their referees"},{"name":"uid","in":"query","schema":{"type":"string"},"description":"Optional UID to filter referees by exact match"},{"name":"userId","in":"query","schema":{"type":"integer"},"description":"Optional user ID to filter referees by exact match"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"referees":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"integer","description":"Referee's user ID"},"uid":{"type":"string","description":"Referee's UID"},"referralCode":{"type":"string","nullable":true,"description":"Referee's own referral code (null if none)"},"commissionRate":{"description":"Sub-affiliate trading fee commission rate (null if not a sub-affiliate)","nullable":true,"allOf":[{"$ref":"#/components/schemas/Decimal"}]},"signedUpAt":{"$ref":"#/components/schemas/Timestamp"},"kycActivatedAt":{"nullable":true,"description":"Timestamp when the referee completed KYC activation (null if not activated)","allOf":[{"$ref":"#/components/schemas/Timestamp"}]}},"required":["userId","uid","signedUpAt"]}}},"required":["referees"]}}}},"400":{"description":"Bad Request\n* UserNotReferral (api.user.notReferral): User does not have a referral code\n* UserNotKol (api.user.notKol): User is not an affiliate\n* InvalidParameter (api.invalidParameter): Invalid pagination parameters or invalid referral code","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized\n* Unauthorized (api.unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden\n* Forbidden (api.forbidden): Referral code is not a sub-affiliate of the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```