/
/Castle API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 14h ago · Updated 1d ago
api-keys1
users6
  • getGet the current user
  • deleteDelete the current user
  • postSubmit the post-signup onboarding survey
  • getGet a user by referral code
  • getGet the current user's outbound referrals (Who I referred?)
  • getGet the current user's referrer. (Who referred me?)
  • get/v2/openapi.json
  • postProvides the inference request cost in nanoUSD for a list of request IDs.
  • postAttach a storage volume to bare metal instance(s)
  • getGet a list of active bare metal rentals
  • postCreate a bare metal rental
  • postRequest a reservation
  • getGet a list of storage volumes
  • postCreate a storage volume
  • getGet a list of active virtual machine rentals
  • postCreate a virtual machine rental
  • getGet a list of past rentals
  • getGet a list of rental options
  • getGet a list of reserve options
  • postReboot a single instance within a virtual machine rental
  • postTerminate a bare metal rental
  • postTerminate a storage volume
  • postTerminate a virtual machine rental
  • postUpdate a rental
  • postUpdate a storage volume
  • getGet a list of storage volume options
  • putUpdate the current user
  • put/users/me/verify-phone-number
  • getGet the current user or organization account's balance
  • postCreate a referral
users

Get a user by referral code

Get a user by referral code

get/users/referrals/by-code/:referralCode

Query parameters

referralCodestring required

Response

Successful response

idstring required
namestring nullable required
emailstring required
referralCodestring nullable required

Changes