> For the complete documentation index, see [llms.txt](https://docs.ai.neevcloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ai.neevcloud.com/api-reference/tenant/referrals.md).

# Referrals

Organization referral listing and related endpoints

## List referrals

> Get list of all referrals for an organization

```json
{"openapi":"3.0.3","info":{"title":"Tenant API","version":"0.1.0"},"tags":[{"name":"Referrals","description":"Organization referral listing and related endpoints"}],"servers":[{"url":"https://api.ai.neevcloud.com/tenant","description":"Consolidated public API gateway"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Use the **`access_token`** from `POST /api/v1/auth/login` (same credentials as the console). In **Authorize**, paste **only that token** — do not prepend `Bearer`, and do not use inference keys (`sk-nc-*`) here. The same token authenticates this API and AI Models / AI Runtime.\n"}},"schemas":{"ReferralListResponse":{"type":"object","description":"Response payload containing list of referrals","required":["referrals"],"properties":{"referrals":{"type":"array","description":"List of referrals","items":{"$ref":"#/components/schemas/ReferralResponse"}}}},"ReferralResponse":{"type":"object","description":"Response payload containing referral details","required":["referred_user_email","status","updated_at"],"properties":{"referred_user_email":{"type":"string","description":"Email address of the user who was referred","format":"email"},"status":{"type":"string","description":"Status of the referral","enum":["signed_up","credit_granted"]},"credit_amount_micro_dollars":{"type":"integer","format":"int64","description":"Credit amount in micro_dollars (1/1000000 of a dollar, e.g., 2000000 = $2.00)","minimum":0},"updated_at":{"type":"string","description":"Timestamp when the referral was last updated","format":"date-time","readOnly":true}}},"ErrorResponse":{"type":"object","description":"Standard error response containing an error message","required":["code","message"],"properties":{"code":{"type":"string","description":"A short, machine-readable error code."},"message":{"type":"string","description":"A descriptive error message."}}}}},"paths":{"/api/v1/orgs/{org_id}/referrals":{"get":{"operationId":"listReferrals","summary":"List referrals","description":"Get list of all referrals for an organization","tags":["Referrals"],"parameters":[{"name":"org_id","description":"Organization ID","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of referrals retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralListResponse"}}}},"400":{"description":"Invalid organization ID format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Missing or invalid authentication token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Insufficient permissions to view referrals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Organization or referrals not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error occurred while retrieving referrals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ai.neevcloud.com/api-reference/tenant/referrals.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.