--- title: "Get the User" method: GET path: "/v2/user" tags: ["user"] --- # Get the User `GET /v2/user` 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. - `createdAt` number, required — UNIX timestamp (in milliseconds) when the User account was created. - `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 - `reason` 'BLOCKED_FOR_PLATFORM_ABUSE' | 'DOMAIN_OWNER_DELETION_REQUEST' | 'ENTERPRISE_TRIAL_ENDED' | 'ENTERPRISE_UNPAID_INVOICE' | 'EXPOSURE_CAP_EXCEEDED' | 'FAIR_USE_LIMITS_EXCEEDED' | 'HOBBY_ALLOCATION_PAUSED' | 'SUBSCRIPTION_CANCELED' | 'SUBSCRIPTION_EXPIRED' | 'UNPAID_INVOICE', 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' - `hobbyAllocationPause` object — Present only when `reason` is `HOBBY_ALLOCATION_PAUSED`. Makes the pause self-describing for support without a separate lookup. - `pausedUntil` number, required — Unix ms timestamp at which the pause is eligible to end. This is the single source of truth for when the pause ends. Never re-derive it by re-checking usage — usage keeps moving while a team is paused, and the pause duration is a fixed experiment parameter. - `pausedAt` number, required — Unix ms timestamp of when the pause was applied. - `triggers` object[], required — Allocations that were at or over 100% when the pause was applied. - `allocation` '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', required — Metered allocation whose included amount was fully consumed. - `usage` number, required — Usage recorded for that allocation when the pause was applied. - `cohort` string, required — Experiment cohort the owner was assigned to when the pause fired. Free-form so cohort naming stays owned by the assignment path. - `billing` object, nullable, required — An object containing billing infomation associated with the User account. - `resourceConfig` object, required — 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. - `concurrentBuilds` 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. - `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. - `awsAccountType` string — 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. - `cfZoneName` string — 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. - `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. - `edgeFunctionMaxSizeBytes` 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. - `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. - `kvDatabases` number — 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. - `blobStores` number — 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. - `cronJobsPerProject` 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. - `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. - `customEnvironmentsPerProject` 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. - `bulkRedirectsFreeLimitOverride` number — An object containing infomation related to the amount of platform resources may be allocated to the User account. - `stagingPrefix` string, required — Prefix that will be used in the URL of "Preview" deployments created by the User account. - `activeDashboardViews` object[] — set of dashboard view preferences (cards or list) per scopeId - `scopeId` string, required - `viewPreference` 'cards' | 'list' | 'null', nullable - `favoritesViewPreference` 'closed' | 'open' | 'null', nullable - `recentsViewPreference` 'closed' | 'open' | 'null', nullable - `importFlowGitNamespace` union - string - number - `importFlowGitNamespaceId` union - string - number - `importFlowGitProvider` 'bitbucket' | 'cursor-origin' | 'github' | 'github-custom-host' | 'github-limited' | 'gitlab' | 'vercel' | 'null', nullable - `preferredScopesAndGitNamespaces` object[] - `scopeId` string, required - `gitNamespaceId` union, required - string - number - `dismissedToasts` object[] — A record of when, under a certain scopeId, a toast was dismissed - `name` string, required - `dismissals` object[], required - `scopeId` string, required - `createdAt` number, required - `favoriteProjectsAndSpaces` object[] — A list of projects and spaces across teams that a user has marked as a favorite. - `teamId` string, required - `projectId` string, required - `hasTrialAvailable` false | true, required — Whether the user has a trial available for a paid plan subscription. - `remoteCaching` object — remote caching settings - `enabled` false | true - `dataCache` object — data cache settings - `excessBillingEnabled` false | true - `featureBlocks` object — Feature blocks for the user - `webAnalytics` object - `blockedFrom` number - `blockedUntil` number - `isCurrentlyBlocked` false | true, required - `isAccountUpdateRequired` false | true — When `true`, the user must complete the EMU Update Account flow before they can use the dashboard. - `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). - `organization` object - `id` string, required - `name` string, required - `slug` string, required - `managedTeams` object[], required - `teamId` string, required - `slug` string, required - `name` string, required - `avatar` string, nullable, required - `workEmail` string, required - `verifiedEmuDomains` string[], required - `id` string, required — The User's unique identifier. - `email` string, required — Email address associated with the User account. - `name` string, nullable, required — Name associated with the User account, or `null` if none has been provided. - `username` string, required — Unique username associated with the User account. - `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. - `isEnterpriseManaged` false | true — Indicates whether the user is managed by an enterprise. - `shouldShowEnterpriseManagedWelcome` false | true — Whether the Enterprise Managed User joined the current team through the Update Account flow and should see its welcome experience. - AuthUserLimited — A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data. - `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. - `id` string, required — The User's unique identifier. - `email` string, required — Email address associated with the User account. - `name` string, nullable, required — Name associated with the User account, or `null` if none has been provided. - `username` string, required — Unique username associated with the User account. - `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. - `isEnterpriseManaged` false | true — Indicates whether the user is managed by an enterprise. - `shouldShowEnterpriseManagedWelcome` false | true — Whether the Enterprise Managed User joined the current team through the Update Account flow and should see its welcome experience. ## Other responses - `302` - `400` - `401` — The request is not authorized. - `403` — You do not have permission to access this resource. - `409` - `410` --- [API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/61d1ba3f6dac/schema)