---
title: "List referrals"
method: GET
path: "/referral/"
tags: ["referral"]
---

# List referrals

`GET /referral/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/referral/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The friends who joined through this workspace's link, newest first.

## Query parameters

- `filters` ListReferralsFilterParamsSchema, required: Query parameters for narrowing the referral list.
  - `status` 'signed_up' | 'converted': How far along one referral is: the list filter's vocabulary. Deliberately NOT Clay's "lead" / "conversion". This product has a Find Leads feature, so a referral labelled a lead reads as a sales prospect.
- `limit` integer: The number of items to return.
- `order_by` 'id' | 'signed_up_at' | 'created_at'
- `order_direction` 'asc' | 'desc'
- `cursor` string, nullable: Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

## Response `200`

Successful Response

- PaginatedResponseReferralReadSchema
  - `data` ReferralReadSchema[]: The list of ResponseItems.
    - `converted_at` string, date-time, nullable, required: When they started their first paid plan; null while still on free.
    - `credits_earned` number, required: Credits this referral has earned the referrer, in decimal credits.
    - `email` string, required
    - `id` string, uuid, required
    - `name` string, nullable, required: The referred person's display name, when known.
    - `signed_up_at` string, date-time, required: When they joined through the link.
    - `status` 'signed_up' | 'converted', required: How far along one referral is: the list filter's vocabulary. Deliberately NOT Clay's "lead" / "conversion". This product has a Find Leads feature, so a referral labelled a lead reads as a sales prospect.
  - `next_page_cursor` string, nullable: The cursor to the next page. If there are no more pages, this is None.
  - `previous_page_cursor` string, nullable: The cursor to the previous page. If there are no previous pages, this is None.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)