Get who is calling
Also answered for a suspended project, so the console can say why. With an API key: its project and its organization's summary (role null), and organizations is null. With a console login: also every organization the user belongs to, with their role and the projects they reach.
GET
/v1/auth/meRequest
| Method and path | GET/v1/auth/me |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
curl "https://api.boxline.dev/v1/auth/me" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst me = await bx.me();console.log(me.project.plan, me.project.limits.features);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLme = bx.me()print(me["project"]["plan"], me["project"]["limits"]["features"])boxline whoami # the project, plan and API of your keyboxline whoami --json # the whole answerResponses
200 OK
Who is calling.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
user | object | null | – | – | null when calling with an API key. |
user.id | string | – | – | |
user.email | string | – | – | Format: email. |
user.name | string | null | – | – | The user's name (signup |
user.isAdmin | boolean | – | – | The email is in ADMIN_EMAILS and confirmed (an unconfirmed address is not an admin). |
user.emailVerified | boolean | – | – | The user confirmed the email (the emailed code, a completed password reset or an accepted invitation). While false, the console offers to confirm it (/v1/auth/confirm-email/send). |
user.emailConfirmationRequired | boolean | – | – | True only for an account made by signup that has not entered its confirmation code yet: it is held back until it does, and the console shows the code page. Never true for accounts made before this rule or confirmed in another way, and false where no mail is delivered (production with the outbox mailer). |
user.emailConfirmationAvailable | boolean | – | – | This server emails confirmation codes: /v1/auth/confirm-email/send can work. False in production with the outbox mailer. |
user.termsCurrentVersion | string | – | – | The current terms version: what accept-terms takes. |
user.termsVersion | string | null | – | – | The latest terms version the user accepted (a date), or null. |
user.termsUpdate | boolean | – | – | The current terms are newer than termsVersion: the console asks the user to accept them. |
impersonatedBy | object | null | – | – | The admin acting as this user, if any. |
impersonatedBy.id | string | – | – | |
impersonatedBy.email | string | – | – | Format: email. |
impersonatedBy.name | string | null | – | – | The user's name (signup |
organization | object | null | – | – | The current organization (an API key's own project's; role null), or null for a console login in none. |
organization.id | string | – | – | |
organization.name | string | – | – | |
organization.plan | string | – | – | |
organization.personal | boolean | – | – | The user's personal organization (made at signup). |
organization.suspended | object | null | – | – | |
organization.suspended.at | string | – | – | Format: date-time. |
organization.suspended.reason | string | null | – | – | |
organization.role | string | null | – | owner, admin, developer, viewer, billing | The caller's role (null with an API key). |
project | object | null | – | – | The current project; null only for a console login without one (no project reached there, or the billing role). |
project.id | string | – | – | |
project.name | string | – | – | |
project.plan | string | – | – | The project's organization's plan. |
project.orgId | string | – | – | |
project.concurrencyCap | integer | null | – | – | The project's own limit on running sessions, below the organization's (null: none). |
project.suspended | object | null | – | – | |
project.suspended.at | string | – | – | Format: date-time. |
project.suspended.reason | string | null | – | – | |
project.limits | object | – | – | |
project.limits.id | string | – | – | |
project.limits.name | string | – | – | |
project.limits.priceUsd | number | null | – | – | null = custom price. |
project.limits.includedUsd | number | – | – | |
project.limits.concurrency | integer | – | – | |
project.limits.maxTimeoutSeconds | integer | – | – | |
project.limits.modelSpendCapUsd | number | null | – | – | null = no cap. |
project.limits.proxyGbPerMonth | number | null | – | – | null = no cap. |
project.limits.captchaSolvesPerMonth | integer | null | – | – | 0 = not on this plan, null = no cap. |
project.limits.maxCredentials | integer | – | – | Credentials a project may keep (passwords and secrets together). |
project.limits.maxProfiles | integer | null | – | – | Browser profiles a project may keep; null = no limit (Free 10, Hobby 100, Startup 500, Scale 2000). |
project.limits.maxProfileBytes | integer | null | – | – | Bytes a project's profiles may hold together; null = no limit (Free 50 MB, Hobby 1 GB, Startup 5 GB, Scale 20 GB). |
project.limits.searchesPerMonth | integer | null | – | – | Web searches included per calendar month (UTC); null = no limit. |
project.limits.extraSearchesPer1000Usd | number | null | – | – | Price per 1,000 searches beyond searchesPerMonth; null = no searches beyond it (402 plan_limit). |
project.limits.webhookEndpoints | integer | null | – | – | Webhook endpoints a project may have; null = no limit. |
project.limits.tasks | integer | null | – | – | Tasks a project may have; null = no plan limit (1,000 per project at most). |
project.limits.schedules | integer | null | – | – | Tasks with a schedule switched on; 0 = no schedules, null = no limit. |
project.limits.retentionDays | integer | – | – | Days an ended session's recording, logs and agent-run steps are kept (Free 7, Hobby and Startup 30, Scale 90). From 1 to 365. |
project.limits.maxCrawlPages | integer | – | – | The most pages one crawl may ask for (Free 200, paid plans 1000). At least 1. |
project.limits.features | object | – | – | What the plan may use. |
project.limits.features.shell | boolean | – | – | |
project.limits.features.profiles | boolean | – | – | |
project.limits.features.recording | boolean | – | – | |
project.limits.features.realisticBrowser | boolean | – | – | |
project.limits.features.residentialProxy | boolean | – | – | |
project.limits.features.datacenterProxy | boolean | – | – | |
project.limits.features.customProxy | boolean | – | – | |
project.limits.features.captchaSolving | boolean | – | – | |
project.limits.features.agentRuns | boolean | – | – | |
project.limits.features.steps | boolean | – | – | |
project.limits.features.extract | boolean | – | – | |
project.limits.features.quickApis | boolean | – | – | |
project.limits.features.crawl | boolean | – | – | |
project.limits.features.loginDetails | boolean | – | – | Credentials of type password, with their 2FA codes. |
project.limits.features.platformModels | boolean | – | – | Model calls on Boxline's own keys. Off on Free, which runs models on the project's own keys only. |
project.limits.features.extensions | boolean | – | – | Chrome extensions (upload them |
project.limits.features.webSearch | boolean | – | – | |
project.limits.public | boolean | – | – | |
project.limits.organizationId | string | null | – | – | Set only on a private plan: the one organization it is for. |
project.trajectories | object | – | – | |
project.trajectories.enabled | boolean | – | – | |
project.trajectories.noticeSeenAt | string | null | – | – | Format: date-time. |
project.trajectories.decidedBy | string | null | – | – | The user who made the last choice (null for an API key). |
organizations | object[] | null | – | – | Every organization of the user (console logins); null with an API key. |
organizations[].id | string | – | – | |
organizations[].name | string | – | – | |
organizations[].plan | string | – | – | |
organizations[].personal | boolean | – | – | The user's personal organization (made at signup). |
organizations[].suspended | object | null | – | – | |
organizations[].suspended.at | string | – | – | Format: date-time. |
organizations[].suspended.reason | string | null | – | – | |
organizations[].role | string | null | – | owner, admin, developer, viewer, billing | The caller's role (null with an API key). |
organizations[].projectAccess | string | – | all, chosen, none | all projects (now and future), chosen ones (projectIds), or none (the billing role). |
organizations[].projects | object[] | – | – | The projects the user reaches there. |
organizations[].projects[].id | string | – | – | |
organizations[].projects[].name | string | – | – |
{ "user": { "id": "usr_Q2x9L0aPz7NmK3Jb", "email": "ada@example.com", "name": "Work account", "isAdmin": false, "emailVerified": false, "emailConfirmationRequired": false, "emailConfirmationAvailable": false, "termsCurrentVersion": "2026-09-29", "termsVersion": "2026-09-29", "termsUpdate": false }, "impersonatedBy": { "id": "usr_Q2x9L0aPz7NmK3Jb", "email": "ada@example.com", "name": "Work account" }, "organization": { "id": "org_Hk2Lq8Zx0Vb5Nm1C", "name": "Work account", "plan": "free", "personal": false, "suspended": { "at": "2026-09-29T10:00:00.000Z", "reason": "…" }, "role": "owner" }, "project": { "id": "prj_Hk2Lq8Zx0Vb5Nm1C", "name": "Work account", "plan": "free", "orgId": "org_Hk2Lq8Zx0Vb5Nm1C", "concurrencyCap": 0, "suspended": { "at": "2026-09-29T10:00:00.000Z", "reason": "…" }, "limits": { "id": "hobby", "name": "Work account", "priceUsd": 0, "includedUsd": 0, "concurrency": 0, "maxTimeoutSeconds": 0, "modelSpendCapUsd": 0, "proxyGbPerMonth": 0, "captchaSolvesPerMonth": 0, "maxCredentials": 0, "maxProfiles": 0, "maxProfileBytes": 0, "searchesPerMonth": 0, "extraSearchesPer1000Usd": 0, "webhookEndpoints": 0, "tasks": 0, "schedules": 0, "retentionDays": 1, "maxCrawlPages": 1, "features": { "shell": false, "profiles": false, "recording": false, "realisticBrowser": false, "residentialProxy": false, "datacenterProxy": false, "customProxy": false, "captchaSolving": false, "agentRuns": false, "steps": false, "extract": false, "quickApis": false, "crawl": false, "loginDetails": false, "platformModels": false, "extensions": false, "webSearch": false }, "public": false, "organizationId": "…" }, "trajectories": { "enabled": false, "noticeSeenAt": "2026-09-29T10:00:00.000Z", "decidedBy": "…" } }, "organizations": [ { "id": "org_Hk2Lq8Zx0Vb5Nm1C", "name": "Work account", "plan": "free", "personal": false, "suspended": { "at": "2026-09-29T10:00:00.000Z", "reason": "…" }, "role": "owner", "projectAccess": "all", "projects": [ { "id": "…", "name": "Work account" } ] } ]}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.