# list_referrals

Source: https://modulify.ai/docs/api/account/list-referrals

Lists the accounts that subscribed through your referral code, with their status and monthly earnings.

- Title: List the people you referred
- Scope: `account:read`
- Access: Read only
- Endpoint: `POST /v1/list_referrals`

This is your own referral record and cannot be pointed at anybody else, and it needs no workspace. A referral is listed once its workspace starts a paid subscription carrying your code, so a free signup is not in it, and [Share and Earn](https://modulify.ai/docs/plans/share-and-earn) invites, a separate program, are not counted here.

Each referral has a masked first name in `Name`, its `Plan`, `BillingPeriod`, `Status` (`active`, `canceled` or `overdue`), `JoinedAt` and `MonthlyEarnings`, your commission in dollars. Search by name with `term`, narrow by `status` and page with `offset` and `limit`, and the answer states the total. See [Referrals and payouts](https://modulify.ai/docs/plans/referrals-and-payouts#the-referrals-tab).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/list_referrals`, sending the inputs below as a JSON object. The token needs the `account:read` scope.

It only reads and changes nothing, so retrying it is safe.

```bash
curl -X POST https://api.modulify.ai/v1/list_referrals \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

Over MCP, the same method is the [list_referrals tool](https://modulify.ai/docs/mcp/account/list-referrals).

## Inputs

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `term` | string | No | Matches part of the referred person's name. |
| `status` | string | No | Only referrals in this status: `active`, `canceled` or `overdue`. |
| `sort` | string | No | `oldest` puts the oldest first. Anything else, or leaving it out, puts the newest first, by the date the referred workspace was created. |
| `offset` | integer | No | How many to skip. |
| `limit` | integer | No | How many to return. Defaults to 8 and is capped at 120. |

## Response

Every call answers with the [JSON envelope](https://modulify.ai/docs/api/requests-and-responses#the-response) of `success`, `message`, `data`, `code` and `version`. `data` holds the result described above, and on a method that returns a total, `count` carries it. The [response headers](https://modulify.ai/docs/api/requests-and-responses#headers-on-every-method-call) carry the call's `X-Request-Id` and what is left of your per-minute budget in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. [Errors](https://modulify.ai/docs/api/errors) explains every status code a call can answer with.