Skip to main content
GET
/
api
/
userinfo
/
Get current user information
curl --request GET \
  --url https://api-v2.missioninbox.com/api/userinfo/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": 123,
  "username": "<string>",
  "email": "jsmith@example.com",
  "ips": "<string>",
  "projects": "<string>",
  "domains": "<string>",
  "mailboxes": "<string>",
  "mailboxes_limit": "<string>",
  "email_usage": "<string>",
  "subscriptionStatus": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "clerk_user_id": "<string>",
  "api_key": "<string>",
  "user_type": "new_user",
  "stripe_customer_id": "<string>",
  "stripe_payment_method_id": "<string>",
  "name": "<string>",
  "subscription": "<string>",
  "subscription_status": "<string>",
  "metered_credits": "<string>",
  "paying_customer": "<string>",
  "flags": "<string>",
  "ibx_smtp": "<string>",
  "ibx_imap": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

​
id
integer
required
​
username
string
required
Maximum length: 100
​
email
string<email>
required
Maximum length: 254
​
ips
string
required
​
projects
string
required
​
domains
string
required
​
mailboxes
string
required
​
mailboxes_limit
string
required
​
email_usage
string
required
​
subscriptionStatus
string
required
​
name
string
required
​
subscription
string
required
​
subscription_status
string
required
​
metered_credits
string
required
​
paying_customer
string
required
​
flags
string
required
​
first_name
string | null
Maximum length: 150
​
last_name
string | null
Maximum length: 150
​
clerk_user_id
string | null
Maximum length: 255
​
api_key
string | null
Maximum length: 255
​
user_type
enum<string>

User subscription type - determines billing behavior and available features

  • new_user - New User (No Subscription)
  • erased - Post-grace period user (erased)
  • old_legacy - Old Legacy (Base Plan)
  • new_legacy - New Legacy (Premium 350 Plan)
  • tiered_monthly - Tiered Monthly Subscription
  • tiered_yearly - Tiered Yearly Subscription
  • cancelled - Cancelled Subscription
Available options:
new_user,
erased,
old_legacy,
new_legacy,
tiered_monthly,
tiered_yearly,
cancelled
​
stripe_customer_id
string | null
Maximum length: 255
​
stripe_payment_method_id
string | null

Default Stripe payment method ID

Maximum length: 255
​
ibx_smtp
string

IBX SMTP server URI

Maximum length: 255
​
ibx_imap
string

IBX IMAP server URI

Maximum length: 255