> ## Documentation Index > Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Get the caller's referral program page data > Returns everything the referrals page needs in one call: the resolved program (payg|enterprise), the shareable sign-up link (code embedded), server-computed credit + USD amounts, the lifetime cap, stats, and the caller's referral rows. Lazily creates the caller's referral code. ## OpenAPI ````yaml /openapi/neo.public.openapi.json get /api/v1/referrals openapi: 3.1.0 info: contact: name: ProjectDiscovery url: https://neo.projectdiscovery.io description: Neo API Server - Security agent orchestration platform license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Neo API version: 1.0.0 servers: - description: Production url: https://neo.api.projectdiscovery.io - description: Development url: https://neo.api.dev.projectdiscovery.io - description: Local development url: http://localhost:8080 security: [] tags: - description: Task execution and management name: Tasks - description: Agent listing and management name: Agents - description: Public agent directory name: Agent Directory - description: User file storage management name: Files - description: User working memory management name: Memory - description: Scheduled and recurring task management name: Schedules - description: Knowledge base and semantic search name: Knowledge - description: Encrypted user credentials and API keys name: Secrets - description: Neo API key management for programmatic access name: API Keys - description: User profile and account information name: User - description: Task and LLM usage tracking name: Usage - description: Bring Your Own Key provider management name: BYOK - description: Model discovery and capabilities name: Models - description: Third-party integrations name: Integrations - description: Skill knowledge documents for agent prompts name: Skills - description: Team management and member invitations name: Teams - description: Prompt library management and discovery name: Prompts - description: Slack bot integration for workspace installation and OAuth name: Slack - description: GitHub integration for PR reviews and repository management name: GitHub - description: Vulnerability issue tracking and management name: Issues - description: Subscription billing and plans name: Billing - description: Project management and member assignments name: Projects - description: SSH key pair generation and management for remote server access name: SSH Keys - description: Codebase structural analysis and mapping name: Codemaps - description: AI-generated codebase documentation and security analysis name: CodeWiki - description: Captured HTTP traffic query and replay name: Network Events - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox name: Triage paths: /api/v1/referrals: get: tags: - Referrals summary: Get the caller's referral program page data description: > Returns everything the referrals page needs in one call: the resolved program (payg|enterprise), the shareable sign-up link (code embedded), server-computed credit + USD amounts, the lifetime cap, stats, and the caller's referral rows. Lazily creates the caller's referral code. operationId: get-v1-referrals responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReferralsResponse' description: Referral program data '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication required '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Internal server error security: - BearerAuth: [] - ApiKeyAuth: [] components: schemas: ReferralsResponse: properties: amounts: $ref: '#/components/schemas/ReferralAmounts' leads: description: >- Enterprise program only: the caller's submitted sales leads (omitted/empty for PAYG) items: $ref: '#/components/schemas/ReferralLeadItem' type: array link: description: >- Shareable sign-up link with the code embedded (ref=CODE); the code is never surfaced separately type: string max_rewards: description: Lifetime successful-referral cap (config-sourced), shown as X of N type: integer program: enum: - payg - enterprise type: string referrals: items: $ref: '#/components/schemas/ReferralItem' type: array stats: $ref: '#/components/schemas/ReferralStats' required: - program - link - amounts - max_rewards - stats - referrals type: object ErrorResponse: properties: code: description: > Stable machine-readable error code — branch on this rather than matching the human `error`/`message` strings. Domain codes include `user_spending_cap_reached`, `project_spending_cap_reached`, and `insufficient_neo_credits`; otherwise it mirrors the error kind (e.g. `forbidden`, `invalid_request`, `not_exists`, `already_exists`). example: user_spending_cap_reached type: string error: example: Bad request type: string error_id: description: Correlation id for a specific error instance, when present. type: string kind: description: Coarse error category (e.g. "forbidden request", "invalid request"). example: forbidden request type: string message: description: | Human-readable detail (the kind prefixed to the error). For display, not for branching. type: string required: - error type: object ReferralAmounts: description: >- Server-computed credit + USD amounts. USD = credits x credit rate, computed server-side; the UI never does the math or hardcodes numbers. properties: lead_credits: description: Credits granted for a closed enterprise lead type: number lead_usd: description: USD value of the lead reward type: number referrer_credits: description: Credits granted to the referrer per successful referral type: number referrer_usd: description: USD value of the referrer reward (credits x rate) type: number required: - referrer_credits - referrer_usd - lead_credits - lead_usd type: object ReferralLeadItem: properties: company: type: string contact_email: type: string contact_name: type: string created_at: format: date-time type: string credits: description: Snapshotted reward credits on rewarded leads nullable: true type: number id: format: uuid type: string status: enum: - pending - rewarded - closed type: string required: - id - contact_name - company - contact_email - status - created_at type: object ReferralItem: properties: created_at: format: date-time type: string credits: description: Snapshotted reward credits on rewarded rows nullable: true type: number id: format: uuid type: string referee_email: description: >- Masked for link-sourced signups; full only for the caller own email invites nullable: true type: string source: enum: - link - email_invite type: string status: enum: - invited - signed_up - pending_reward - rewarded - ineligible - reversed type: string required: - id - status - source - created_at type: object ReferralStats: properties: credits_earned: description: >- Sum of credits earned, from reward snapshots (not rewarded times current rate) type: number referred: description: Total people attributed to the caller type: integer rewarded: description: Successful (rewarded) referrals type: integer required: - referred - rewarded - credits_earned type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT authentication token scheme: bearer type: http ApiKeyAuth: description: Neo API key (neo_sk_* prefix) in: header name: X-Api-Key type: apiKey ````