> ## Documentation Index > Fetch the complete documentation index at: https://docs.nxos.io/llms.txt > Use this file to discover all available pages before exploring further. # List referral links > List your referral links. A referral link is the same for every customer and carries no email: the customer signs up with any address, and the new organization is attributed to you as its referrer. To lock the sign-up to one customer's email, issue a link with `POST /v1/referral-invites` instead. The list is empty until referrals are switched on for your organization, from the Referrals page of the dashboard or by a first call to `POST /v1/referral-invites`. ## OpenAPI ````yaml GET /v1/referral-links openapi: 3.0.0 info: title: nxos API version: 1.0.0 contact: name: nxos url: https://nxos.io description: |- The nxos platform API provides programmatic access to accounts, balances, quotes, and trades. All endpoints require API key authentication. servers: - url: https://api.nxos.io description: Production variables: {} - url: https://api.sandbox.nxos.io description: Sandbox variables: {} security: [] tags: - name: Accounts - name: Quotes - name: Beneficiaries - name: Fiat Payouts - name: Crypto Payouts - name: Sandbox Faucet - name: Nxosnet - name: Fees - name: Sub-Org Tiers - name: Funding Methods - name: Transactions - name: Organizations - name: Authorizations - name: Referral invites - name: Referral links - name: Webhooks description: >- Register an HTTPS endpoint to receive events (organization verification and transaction status changes) instead of polling. Deliveries are signed; verify the `svix-signature` header before acting on an event. See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for the delivery format, signature verification, retries, and broker behavior. Payload shapes are documented in the `…Event` models below. paths: /v1/referral-links: get: tags: - Referral links description: >- List your referral links. A referral link is the same for every customer and carries no email: the customer signs up with any address, and the new organization is attributed to you as its referrer. To lock the sign-up to one customer's email, issue a link with `POST /v1/referral-invites` instead. The list is empty until referrals are switched on for your organization, from the Referrals page of the dashboard or by a first call to `POST /v1/referral-invites`. operationId: ReferralLinks_list parameters: - $ref: '#/components/parameters/ApiKeyAuth' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ReferralLinkList' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error401' '429': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error429' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Error500' components: parameters: ApiKeyAuth: name: Authorization in: header required: true description: 'Bearer token. Format: `Bearer `' schema: type: string schemas: ReferralLinkList: type: object required: - object - data - hasMore - nextCursor properties: object: type: string enum: - list description: Object type. Always `list`. data: type: array items: $ref: '#/components/schemas/ReferralLink' description: Your referral links, newest first. hasMore: type: boolean description: 'Always `false`: every link is returned.' nextCursor: type: string nullable: true description: 'Always `null`: the list is not paginated.' description: Your referral links. Error401: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: missing_api_key message: No Authorization header provided. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error429: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: rate_limited message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.' requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error500: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: internal_error message: An unexpected server error occurred. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 ReferralLink: type: object required: - object - referralLinkId - label - status - url - signupCount - createdAt properties: object: type: string enum: - referral_link description: Object type. Always `referral_link`. referralLinkId: type: string description: Unique identifier of the link. label: type: string nullable: true description: The name given to the link in the dashboard (e.g. `Primary`). status: allOf: - $ref: '#/components/schemas/ReferralLinkStatus' description: Whether sign-ups through the link are attributed to you. url: type: string description: >- Link to send customers to. It opens the Nxos sign-up showing you as the referrer; the customer signs up with any email they choose. signupCount: type: integer format: int32 description: Number of organizations that signed up through this link. createdAt: allOf: - $ref: '#/components/schemas/dateTimeString' description: ISO 8601 timestamp of when the link was created. description: >- A referral link you share with anyone you refer: the same link for every customer, with no email attached. example: object: referral_link referralLinkId: ref_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d label: Primary status: ACTIVE url: https://app.nxos.io/r/k7x2m9qp signupCount: 12 createdAt: '2026-10-06T14:30:00.000Z' ErrorBody: type: object required: - code - message - requestId properties: code: allOf: - $ref: '#/components/schemas/ErrorCode' description: Machine-readable error code. message: type: string description: Human-readable error message. requestId: type: string description: Unique identifier for this request, useful for debugging. ReferralLinkStatus: type: string enum: - ACTIVE - DISABLED description: Referral link status. dateTimeString: type: string description: ISO 8601 timestamp string. ErrorCode: type: string enum: - missing_api_key - authentication_failed - invalid_api_key - forbidden - swap_direction_not_allowed - sub_org_tier_not_available - service_not_enabled - not_found - organization_not_found - account_not_found - quote_not_found - beneficiary_not_found - transaction_not_found - funding_method_not_found - authorization_not_found - nxosnet_handle_not_found - sub_org_tier_not_found - quote_expired - quote_already_used - beneficiary_already_archived - beneficiary_not_archived - beneficiary_blocked - nxosnet_not_enabled - nxosnet_handle_taken - chain_send_failed - idempotency_key_in_use - idempotency_request_in_flight - referral_invite_already_accepted - invalid_request - insufficient_funds - trade_size_out_of_bounds - validation_error - share_token_invalid - verification_import_unsupported - verification_required - rate_limited - webhooks_unavailable - internal_error description: All possible error codes returned by the API. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.