Account Profile
Returns the profile of your active account: whether it is a personal or a company account, the company details, and where its setup stands in the Create account wizard.
Requires the settings:read permission. To change the profile, see Update Account Profile.
Response (200 OK)
entity_type string
individual or company. Empty for an account that has no profile yet, such as the account created when you signed up.company object
The company details:
legal_name, website, size, industry, country (two-letter ISO 3166-1 code). Every field is an empty string when not set, and all of them are empty on an individual account.onboarding.step string
The wizard step the setup resumes at:
account (step 1 of your own account, the one made when you signed up), plan, billing, payment, review, team or start. Empty for an account without a setup: one created before the wizard existed, or through the API without onboarding: true.onboarding.use_case string
The answer to "What will you run?":
tunnels, apps, edge or unsure. Empty until it is answered.onboarding.completed_at string | null
When the setup was finished (RFC 3339), or
null.onboarding.pending bool
true while the account's setup is unfinished. The dashboard then opens the wizard on every page of this account. The API answers as usual.viewer_can_finish bool
true when you can finish the setup: you are the account owner. Other members see a holding page in the dashboard until the owner finishes.Errors
401 Unauthorized
Missing or invalid auth.
403 Forbidden
No active account selected, or you lack the
settings:read permission in this account.404 Not Found
The active account no longer exists.
Request
curl "https://api.ngris.com/v1/account/profile" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
profile = client._get_raw("/account/profile")
if profile["onboarding"]["pending"]:
print("Setup unfinished, resumes at", profile["onboarding"]["step"])
Response — 200 OK
{
"entity_type": "company",
"company": {
"legal_name": "Acme Ltd",
"website": "https://acme.example",
"size": "11-50",
"industry": "saas",
"country": "FI"
},
"onboarding": {
"step": "start",
"use_case": "apps",
"completed_at": "2026-10-15T10:12:58Z",
"pending": false
},
"viewer_can_finish": true
}