Skip to docs content
Browse and search
On this page

get_account

Read the account: email, name, terms, referral code and credits, stream setup progress, and Discord community standing and notification settings. The email is masked (j***@example.com) unless the request carries a recent email-code sign-in. A section that could not be read is null and named in refusals. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:account scope.

POST/api/agent/actions/get_account

Authorization

  • AuthorizationstringheaderrequiredBearer authentication with your TweetStream API key: Bearer <key>.

Headers

  • X-TweetStream-Setup-ProofstringheaderoptionalOptional. The setupProof returned by email verification; when present, the account email is shown in full.

Body

json
{}

Response fields

  • discordobjectrequired
    • billingDmsobjectrequired
      • eligiblebooleanrequired
      • enabledbooleanrequired
    • communityobjectrequired
      • botInstalledbooleanrequired
      • channelReadybooleanrequired
      • linkedbooleanrequired
      • membershipenum<string>required
      • multipleLinkedbooleanrequired
      • onboardingRequiredbooleanrequired
      • requiredbooleanrequiredWhether this account is asked to join the TweetStream Discord community. Only a checkout whose status is community_required waits for it.
      • verificationPendingbooleanrequired
      • verifiedbooleanrequired
    • limitAlertsbooleanrequired
  • emailstringrequired
  • namestringrequired
  • realtimeSetupobjectrequired
    • standardobjectrequired
      • firstAlertAtstringrequired
      • lastConnectedAtstringrequired
    • ultra_speedobjectrequired
      • firstAlertAtstringrequired
      • lastConnectedAtstringrequired
  • referralobjectrequired
    • canReferbooleanrequired
    • codestringrequired
    • issuedThisYearCentsintegerrequiredan integer
    • nextCreditUseAtstringrequired
    • onHoldbooleanrequired
    • pendingCreditsCentsintegerrequiredan integer
    • referralsobject[]required
      • amountCentsintegerrequiredan integer
      • createdAtstringrequireda string to be decoded into a Date
      • maturesAtstringrequired
      • statusenum<string>required
    • successfulReferralsintegerrequiredan integer
    • urlstringrequired
  • refusalsobject[]required
    • messagestringrequired
    • reasonenum<string>required
    • sectionenum<string>required
  • termsobjectrequired
    • acceptedAtstringrequired
    • acceptedVersionstringrequired
    • currentVersionstringrequired
    • needsAcceptancebooleanrequired

Responses

  • 200Success
  • 400The input does not match the action's schema (INVALID_REQUEST)
  • 401Missing or invalid API key
  • 403The request carried a foreign Origin
  • 429Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds
  • 503Temporarily unavailable; retry later