Referrals

Gets a referral by ID

Returns a referral object by ID if it exists.

get/v1/referrals/{id}

Request

Base URL
https://api.brex.com
Auth
OAuth 2
Client credentials
Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
TypeScript
https://skmtc.dev/brex-com/apis/onboarding-api/docs/v1/referrals/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Success

idstring required

Unique identifier for the referral.

referral_signup_urlstring 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_atstring date-time required

The time at which this referral link expires.

customer_emailstring 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.

{
  "id": "a1b2c3d4e5f6g7",
  "referral_signup_url": "https://brex.com/signup?pref_token=a1b2c3d4e5f6g7"
}

No recorded changes to this operation across all 2 revisions of this API.