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

# List referrals

`GET /v1/referrals`

Returns referrals created.
*Note*: This doesn't include referrals that have expired.

## Query parameters

- `cursor` string, nullable

## Response `200`

Success

- ReferralPage
  - `next_cursor` string, nullable
  - `items` Referral[], required
    - `id` string, required — Unique identifier for the referral.
    - `referral_signup_url` string, required — Signup URL to redirect prospects to complete their onboarding flow. *Note*: Necessary disclosures must be shown when the prospect clicks on this link.
    - `expires_at` string, date-time, required — The time at which this referral link expires.
    - `customer_email` string, email, nullable — Customer's email address registered for the Brex application. This field is available only if there's a signup completed.
    - `status` 'UNCLAIMED' | 'EXPIRED' | 'ACTIVE' | 'CLOSED', required — Status of the referral. `UNCLAIMED` or `EXPIRED` unless the customer completes signup. Customers are attributed once `ACTIVE` until the account is `CLOSED`.
    - `products` Product[], required
      - `cash` Cash, required — Available if customer applied for Brex Cash.
        - `accounts` Account[], nullable
          - `id` string, required — Brex Cash management account ID.
          - `instructions` Instruction — Domestic and international ACH/wire instructions.
            - `domestic` DomesticInstruction, required — Domestic ACH/wire instructions.
              - …
            - `international` InternationalInstruction, required — International wire instructions.
              - …
          - `created_at` string, date-time, required
        - `application` Application, required
          - `status` 'NO_ACCOUNT' | 'ACTIVE' | 'NOT_SUBMITTED' | 'INFORMATION_PENDING' | 'MANUAL_REVIEW' | 'PROCESSING' | 'REJECTED' | 'CLOSED', required — Application status of a product. `NO_ACCOUNT` - There is no active application, and the product account is not provisioned. `ACTIVE` - The application is approved, and the product account is provisioned. `NOT_SUBMITTED` - The application is started but not yet submitted. `INFORMATION_PENDING` - The application is submitted and additional information is requested. `MANUAL_REVIEW` - The application is under manual review. `PROCESSING` - The application is submitted and is under review. `REJECTED` - The application is rejected. `CLOSED` - The product account is closed.

## Other responses

- `400` — Invalid cursor
- `401` — Unauthorized

---

[API](https://skmtc.net/brex-com/apis/onboarding-api.md) · [All operations](https://skmtc.net/brex-com/apis/onboarding-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brex-com/onboarding-api/revisions/9a5329a23c39/schema)