--- title: "Get the User" method: GET path: "/v2/user" tags: ["user"] --- # Get the User `GET /v2/user` ## Request - Base URL: `https://api.vercel.com` - URL: `https://api.vercel.com/v2/user` - Auth: HTTP bearer Retrieves information related to the currently authenticated User. ## Response `200` Successful response. - object: Successful response. - `user` union, required - AuthUser: Data for the currently authenticated User. - `accountUpdateContext` object: Context for the Update Account screen. Present only when `isAccountUpdateRequired` is true. `managedTeams` is empty for orphan mode (user matches an EMU domain but is not on the team). When the teams the user must complete Update Account for include an organization's backing team, that team is listed as the organization, followed by the organization's Enterprise Managed root and child teams the user is a member of, including through Directory Sync group mappings. - `canOptOut` false | true, required: Whether this user can cancel their optional Account Update flow. - `managedTeams` object[], required - `avatar` string, nullable, required - `name` string, required - `slug` string, required - `teamId` string, required - `workEmail` string, required - `organization` object - `id` string, required - `name` string, required - `slug` string, required - `verifiedEmuDomains` string[], required - `activeDashboardViews` object[]: set of dashboard view preferences (cards or list) per scopeId - `favoritesViewPreference` 'closed' | 'open' | 'null', nullable - `recentsViewPreference` 'closed' | 'open' | 'null', nullable - `scopeId` string, required - `viewPreference` 'cards' | 'list' | 'null', nullable - `avatar` string, nullable, required: SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. - `billing` object, nullable, required: An object containing billing infomation associated with the User account. - `createdAt` number, required: UNIX timestamp (in milliseconds) when the User account was created. - `dataCache` object: data cache settings - `excessBillingEnabled` false | true - `defaultTeamId` string, nullable, required: The user's default team. - `dismissedToasts` object[]: A record of when, under a certain scopeId, a toast was dismissed - `dismissals` object[], required - `createdAt` number, required - `scopeId` string, required - `name` string, required - `email` string, required: Email address associated with the User account. - `favoriteProjectsAndSpaces` object[]: A list of projects and spaces across teams that a user has marked as a favorite. - `projectId` string, required - `teamId` string, required - `featureBlocks` object: Feature blocks for the user - `speedInsightsFree` object: Client-facing view of the `speedInsightsFree` ingestion block. The dashboard needs `blockReason` to tell usage pauses apart from admin blocks. - `blockedFrom` number - `blockedUntil` number - `blockReason` 'admin_override' | 'hard_blocked' | 'limits_exceeded', required - `isCurrentlyBlocked` false | true, required - `webAnalytics` object - `blockedFrom` number - `blockedUntil` number - `isCurrentlyBlocked` false | true, required - `hasTrialAvailable` false | true, required: Whether the user has a trial available for a paid plan subscription. - `id` string, required: The User's unique identifier. - `importFlowGitNamespace` union - string - number - `importFlowGitNamespaceId` union - string - number - `importFlowGitProvider` 'bitbucket' | 'cursor-origin' | 'github' | 'github-custom-host' | 'github-limited' | 'gitlab' | 'vercel' | 'null', nullable - `isAccountUpdateRequired` false | true: When `true`, the user must complete the EMU Update Account flow before they can use the dashboard. - `isEnterpriseManaged` false | true: Indicates whether the user is managed by an enterprise. - `name` string, nullable, required: Name associated with the User account, or `null` if none has been provided. - `preferredScopesAndGitNamespaces` object[] - `gitNamespaceId` union, required - string - number - `scopeId` string, required - `remoteCaching` object: remote caching settings - `enabled` false | true - `resourceConfig` object, required: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `awsAccountIds` string[]: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `awsAccountType` string: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `blobStores` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `buildEntitlements` object: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `enhancedBuilds` false | true: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `buildQueue` object: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `configuration` 'SKIP_NAMESPACE_QUEUE' | 'WAIT_FOR_NAMESPACE_QUEUE': An object containing infomation related to the amount of platform resources may be allocated to the User account. - `bulkRedirectsFreeLimitOverride` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `cfZoneName` string: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `concurrentBuilds` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `cronJobsPerProject` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `customEnvironmentsPerProject` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `edgeConfigs` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `edgeConfigSize` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `edgeFunctionExecutionTimeoutMs` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `edgeFunctionMaxSizeBytes` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `elasticConcurrencyEnabled` false | true: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `flagsExplorerOverridesThreshold` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `flagsExplorerUnlimitedOverrides` false | true: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `imageOptimizationType` string: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `integrationStores` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `kvDatabases` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `microfrontendGroupsPerTeam` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `microfrontendProjectsPerGroup` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `nodeType` string: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `postgresDatabases` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `security` object: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `customRules` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `ipBlocks` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `ipBypass` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `rateLimit` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `securityLists` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `teamLevelConditions` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `teamLevelRules` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `teamLevelRulesets` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `serverlessFunctionMaxDuration` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `serverlessFunctionMaxMemorySize` number: An object containing infomation related to the amount of platform resources may be allocated to the User account. - `shouldShowEnterpriseManagedWelcome` false | true: Whether the Enterprise Managed User joined the current team through the Update Account flow and should see its welcome experience. - `softBlock` object, nullable, required: When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why. - `blockedAt` number, required - `blockedDueToOverageType` 'analyticsUsage' | 'artifacts' | 'bandwidth' | 'blobDataTransfer' | 'blobTotalAdvancedRequests' | 'blobTotalAvgSizeInBytes' | 'blobTotalGetResponseObjectSizeInBytes' | 'blobTotalSimpleRequests' | 'connectDataTransfer' | 'dataCacheRead' | 'dataCacheWrite' | 'edgeConfigRead' | 'edgeConfigWrite' | 'edgeFunctionExecutionUnits' | 'edgeMiddlewareInvocations' | 'edgeRequest' | 'edgeRequestAdditionalCpuDuration' | 'elasticConcurrencyBuildSlots' | 'fastDataTransfer' | 'fastOriginTransfer' | 'fluidCpuDuration' | 'fluidDuration' | 'functionDuration' | 'functionInvocation' | 'imageOptimizationCacheRead' | 'imageOptimizationCacheWrite' | 'imageOptimizationTransformation' | 'logDrainsVolume' | 'monitoringMetric' | 'observabilityEvent' | 'onDemandConcurrencyMinutes' | 'runtimeCacheRead' | 'runtimeCacheWrite' | 'serverlessFunctionExecution' | 'sourceImages' | 'wafOwaspExcessBytes' | 'wafOwaspRequests' | 'wafRateLimitRequest' | 'webAnalyticsEvent' - `reason` 'BLOCKED_FOR_PLATFORM_ABUSE' | 'DOMAIN_OWNER_DELETION_REQUEST' | 'ENTERPRISE_TRIAL_ENDED' | 'ENTERPRISE_UNPAID_INVOICE' | 'EXPOSURE_CAP_EXCEEDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE', required - `unpauseAt` number: Since September 2026. Set only by `billing-usage-alerts` for usage plans with a `blockDurationMs`; its presence marks a pause that expires on its own. - `stagingPrefix` string, required: Prefix that will be used in the URL of "Preview" deployments created by the User account. - `username` string, required: Unique username associated with the User account. - AuthUserLimited: A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data. - `avatar` string, nullable, required: SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. - `defaultTeamId` string, nullable, required: The user's default team. - `email` string, required: Email address associated with the User account. - `id` string, required: The User's unique identifier. - `isEnterpriseManaged` false | true: Indicates whether the user is managed by an enterprise. - `limited` true, required: Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges. - `name` string, nullable, required: Name associated with the User account, or `null` if none has been provided. - `shouldShowEnterpriseManagedWelcome` false | true: Whether the Enterprise Managed User joined the current team through the Update Account flow and should see its welcome experience. - `username` string, required: Unique username associated with the User account. ## Other responses - `302` - `400` - `401`: The request is not authorized. - `403`: You do not have permission to access this resource. - `409` - `410` ## Changes - **2026-10-08** `f5c63f03ee0c`: 4 info - added the optional property `user/oneOf[#/components/schemas/AuthUser]/resourceConfig/security/securityLists` to the response with the `200` status - added the optional property `user/oneOf[#/components/schemas/AuthUser]/resourceConfig/security/teamLevelConditions` to the response with the `200` status - added the optional property `user/oneOf[#/components/schemas/AuthUser]/resourceConfig/security/teamLevelRules` to the response with the `200` status - added the optional property `user/oneOf[#/components/schemas/AuthUser]/resourceConfig/security/teamLevelRulesets` to the response with the `200` status - **2026-09-11** `83dbc1a3d2a1`: 1 info - added the optional property `user/oneOf[#/components/schemas/AuthUser]/softBlock/unpauseAt` to the response with the `200` status - **2026-09-10** `a5ba4ada31fd`: 1 warning, 1 info - removed the optional property `user/oneOf[#/components/schemas/AuthUser]/softBlock/hobbyAllocationPause` from the response with the `200` status - removed the `HOBBY_ALLOCATION_PAUSED` enum value from the `user/oneOf[#/components/schemas/AuthUser]/softBlock/reason` response property for the response status `200` - **2026-08-28** `cea4418b1cd8`: 1 info - added the required property `user/oneOf[#/components/schemas/AuthUser]/accountUpdateContext/canOptOut` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/vercel/apis/vercel-api/changes/v2/user/get.md) --- [API](https://skmtc.dev/vercel/apis/vercel-api.md) - [All operations](https://skmtc.dev/vercel/apis/vercel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vercel/apis/vercel-api/revisions/60686c0e1f6a?raw)