Skip to main content

User

idstringrequired
emailstringrequired
noPasswordbooleanrequired
linkedAccounts object[]required
  • Array [
  • sourcestringrequired

    Possible values: [google, apple]

    namestringrequired
    picturestring
  • ]
  • subscription objectrequired
    plan object
    idPlanId (string)required

    id of subscription plan

    titlestringrequired
    pricenumber<float>required
    savePerReportnumber<float>required
    reportsinteger<uint16>required
    discountinteger<uint8>
    badgestring
    statusstringrequired

    Possible values: [notexists, active, canceled, inactive]

    nextstring<date-time>
    urlstring
    errorstring
    activebooleanrequired
    needShowbooleanrequired
    isPromobooleanrequired
    updatedstring<date-time>
    canSearchbooleanrequired
    canShareReportboolean
    emailConfirmedbooleanrequired
    receiveEmailsbooleanrequired
    availableReportsinteger<uint16>required
    sessionIdstring
    offerinteger<int64>
    searchIconsSearchIcon (string)[]

    Ordered list of icons the search form must render, already filtered by server config. Every server that supports this field emits it on every response — as an array, never null, possibly empty. It is optional for one reason only: a server older than this field omits it, and a client seeing it omitted falls back to its own default row. A supporting server omitting it is a bug, not a state. Consumers filter it further by what they can actually render.

    Possible values: [ig, fb, tw, tt, li, phone]

    showLinkedInbooleandeprecated

    Superseded by searchIcons, from which it is derived. Kept until no shipped client reads it — sp-capacitor-app bundles a frozen static export, so removal needs a full app-release cycle.

    Default value: false
    isAdminboolean

    Whether the user has administrative access.

    Default value: false
    chat_agent_access_tokenstring

    JWT for chat agent WebSocket (init-chat.access_token). Present only when GET /auth/info was called with include_chat_agent_token=true and the server supports issuing the token.

    credits object

    Breakdown of a caller's credit wallet. Three buckets fund one balance: plan is granted by the subscription for the current period and is burned at the rollover, while referral and bonus never expire. Render available — the other five fields are the breakdown behind it.

    totalinteger<int32>required

    Sum of the three bucket balances exactly as stored (plan + referral + bonus), with neither expiry nor the subscription gate applied. Diagnostic: it can exceed available.

    Possible values: >= 0

    planinteger<int32>required

    Balance granted by the subscription for the current period. Whatever is left of it is burned at the period rollover, never carried over.

    Possible values: >= 0

    referralinteger<int32>required

    Balance granted for referrals. Never expires.

    Possible values: >= 0

    bonusinteger<int32>required

    Balance granted manually (support, promotions). Never expires.

    Possible values: >= 0

    availableinteger<int32>required

    What the caller can actually spend right now: plan counted only while the current period window is still open, plus referral and bonus — and zero whenever the subscription is not active, since referral and bonus credits are not spendable without one. This is the field a client should render.

    Possible values: >= 0

    usedinteger<int32>required

    Spends in the CURRENT period, across all three buckets. It resets at the period rollover; it is not a lifetime total.

    Possible values: >= 0

    User
    {
    "id": "string",
    "email": "string",
    "noPassword": true,
    "linkedAccounts": [
    {
    "source": "google",
    "name": "string",
    "picture": "string"
    }
    ],
    "subscription": {
    "plan": {
    "id": "string",
    "title": "string",
    "price": 0,
    "savePerReport": 0,
    "reports": 0,
    "discount": 0,
    "badge": "string"
    },
    "status": "notexists",
    "next": "2024-07-29T15:51:28.071Z",
    "url": "string",
    "error": "string",
    "active": true,
    "needShow": true,
    "isPromo": true,
    "updated": "2024-07-29T15:51:28.071Z"
    },
    "canSearch": true,
    "canShareReport": true,
    "emailConfirmed": true,
    "receiveEmails": true,
    "availableReports": 0,
    "sessionId": "string",
    "offer": 0,
    "searchIcons": [
    "ig"
    ],
    "isAdmin": false,
    "chat_agent_access_token": "string",
    "credits": {
    "total": 0,
    "plan": 0,
    "referral": 0,
    "bonus": 0,
    "available": 0,
    "used": 0
    }
    }