Invite

Get invite account

Changed on

Get invite account info including access status, owned codes, and invitees.

get/v1/invite/account/{account}

Request

Path parameters

accountstring required

Response

A successful response.

has_accessboolean
statusstring
invited_bystring
activated_atstring int64
terms_acceptedboolean
volumestring
invitees_volumestring
cumulative_volumestring
total_codes_earnedinteger

Progress toward next code at the upcoming Thursday drop. total_codes_earned is what the next drop will mint based on cumulative_volume so far this week, capped at 5. next_code_threshold is the lowest cumulative_volume value that would unlock one more code; "0" once at the cap.

next_code_thresholdstring
next_code_drop_timestring int64
deposit_deadlinestring int64

DEPRECATED: redemptions no longer expire. Always 0; kept for FE back-compat and will be removed once the FE drops it.

volume_makerstring

Maker / taker split for the current weekly window. Sums of these match volume / invitees_volume above.

volume_takerstring
invitees_volume_makerstring
invitees_volume_takerstring
invitees_volume_all_time_makerstring

DEPRECATED: moved to GetReferralSummary (referred_volume_all_time_maker / referred_volume_all_time_taker). Still populated for back-compat; will be removed once the FE migrates to the new endpoint.

invitees_volume_all_time_takerstring

Changes