Get the User | Vercel REST API

APIs & SDKs

Get the User

GEThttps://api.vercel.com/v2/user

Retrieves information related to the currently authenticated User.

https://api.vercel.com/v2/user

const response = await fetch('https://api.vercel.com/v2/user', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "user": {
    "accountUpdateContext": {
      "canOptOut": "false",
      "managedTeams": [
        {
          "avatar": "string",
          "name": "Example Name",
          "slug": "string",
          "teamId": "example_id",
          "workEmail": "user@example.com"
        }
      ],
      "organization": {
        "id": "icfg_1234567890",
        "name": "Example Name",
        "slug": "string"
      },
      "verifiedEmuDomains": []
    },
    "activeDashboardViews": [
      {
        "favoritesViewPreference": "closed",
        "recentsViewPreference": "closed",
        "scopeId": "example_id",
        "viewPreference": "cards"
      }
    ],
    "avatar": "22cb30c85ff45ac4c72de8981500006b28114aa1",
    "billing": "value",
    "createdAt": "1630748523395",
    "dataCache": {
      "excessBillingEnabled": "false"
    },
    "defaultTeamId": "example_id",
    "dismissedToasts": [
      {
        "dismissals": [
          {
            "createdAt": "123",
            "scopeId": "example_id"
          }
        ],
        "name": "Example Name"
      }
    ],
    "email": "me@example.com",
    "favoriteProjectsAndSpaces": [
      {
        "projectId": "example_id",
        "teamId": "example_id"
      }
    ],
    "featureBlocks": {
      "speedInsightsFree": {
        "blockedFrom": "123",
        "blockedUntil": "123",
        "blockReason": "admin_override",
        "isCurrentlyBlocked": "false"
      },
      "webAnalytics": {
        "blockedFrom": "123",
        "blockedUntil": "123",
        "isCurrentlyBlocked": "false"
      }
    },
    "hasTrialAvailable": "false",
    "id": "AEIIDYVk59zbFF2Sxfyxxmua",
    "importFlowGitNamespace": "Example Name",
    "importFlowGitNamespaceId": "Example Name",
    "importFlowGitProvider": "bitbucket",
    "isAccountUpdateRequired": "false",
    "isEnterpriseManaged": "false",
    "name": "John Doe",
    "preferredScopesAndGitNamespaces": [
      {
        "gitNamespaceId": "Example Name",
        "scopeId": "example_id"
      }
    ],
    "remoteCaching": {
      "enabled": "false"
    },
    "resourceConfig": {
      "awsAccountIds": [],
      "awsAccountType": "string",
      "blobStores": "123",
      "buildEntitlements": {
        "enhancedBuilds": "false"
      },
      "buildQueue": {
        "configuration": "SKIP_NAMESPACE_QUEUE"
      },
      "bulkRedirectsFreeLimitOverride": "123",
      "cfZoneName": "Example Name",
      "concurrentBuilds": "123",
      "cronJobsPerProject": "123",
      "customEnvironmentsPerProject": "123",
      "edgeConfigs": "123",
      "edgeConfigSize": "123",
      "edgeFunctionExecutionTimeoutMs": "123",
      "edgeFunctionMaxSizeBytes": "123",
      "elasticConcurrencyEnabled": "false",
      "flagsExplorerOverridesThreshold": "123",
      "flagsExplorerUnlimitedOverrides": "false",
      "imageOptimizationType": "string",
      "integrationStores": "123",
      "kvDatabases": "123",
      "microfrontendGroupsPerTeam": "123",
      "microfrontendProjectsPerGroup": "123",
      "nodeType": "string",
      "postgresDatabases": "123",
      "security": {
        "customRules": "123",
        "ipBlocks": "123",
        "ipBypass": "123",
        "rateLimit": "123",
        "securityLists": "123",
        "teamLevelConditions": "123",
        "teamLevelRules": "123",
        "teamLevelRulesets": "123"
      },
      "serverlessFunctionMaxDuration": "123",
      "serverlessFunctionMaxMemorySize": "123"
    },
    "shouldShowEnterpriseManagedWelcome": "false",
    "softBlock": {
      "blockedAt": "123",
      "blockedDueToOverageType": "analyticsUsage",
      "reason": "BLOCKED_FOR_PLATFORM_ABUSE",
      "unpauseAt": "123"
    },
    "stagingPrefix": "string",
    "username": "jdoe"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Response

200Successful response.

userobjectRequired2 variants

Errors

400Error

401The request is not authorized.

403You do not have permission to access this resource.

409Error

410Error

Cross-link map: Get the User (/docs/rest-api/user/get-the-user)

From the Vercel docs graph (built 2026-10-13T05:35:52.211Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get configurations for the authenticated user or team — GET /v1/integrations/configurations — Allows to retrieve all configurations for an authenticated integration. When the \
Returns activated WAF config — GET /v1/security/firewall/config — Lists WAF configs for a project
Get access request status — GET /v1/teams/{teamId}/request/{userId} — Check the status of a join request. It'll respond with a 404 if the request ha
List team members — GET /v3/teams/{teamId}/members — Get a paginated list of team members for the provided team.
Get Account Information — GET /v1/installations/{integrationConfigurationId}/account — Fetches the best account or user’s contact info

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v2/user

const response = await fetch('https://api.vercel.com/v2/user', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "user": {
    "accountUpdateContext": {
      "canOptOut": "false",
      "managedTeams": [
        {
          "avatar": "string",
          "name": "Example Name",
          "slug": "string",
          "teamId": "example_id",
          "workEmail": "user@example.com"
        }
      ],
      "organization": {
        "id": "icfg_1234567890",
        "name": "Example Name",
        "slug": "string"
      },
      "verifiedEmuDomains": []
    },
    "activeDashboardViews": [
      {
        "favoritesViewPreference": "closed",
        "recentsViewPreference": "closed",
        "scopeId": "example_id",
        "viewPreference": "cards"
      }
    ],
    "avatar": "22cb30c85ff45ac4c72de8981500006b28114aa1",
    "billing": "value",
    "createdAt": "1630748523395",
    "dataCache": {
      "excessBillingEnabled": "false"
    },
    "defaultTeamId": "example_id",
    "dismissedToasts": [
      {
        "dismissals": [
          {
            "createdAt": "123",
            "scopeId": "example_id"
          }
        ],
        "name": "Example Name"
      }
    ],
    "email": "me@example.com",
    "favoriteProjectsAndSpaces": [
      {
        "projectId": "example_id",
        "teamId": "example_id"
      }
    ],
    "featureBlocks": {
      "speedInsightsFree": {
        "blockedFrom": "123",
        "blockedUntil": "123",
        "blockReason": "admin_override",
        "isCurrentlyBlocked": "false"
      },
      "webAnalytics": {
        "blockedFrom": "123",
        "blockedUntil": "123",
        "isCurrentlyBlocked": "false"
      }
    },
    "hasTrialAvailable": "false",
    "id": "AEIIDYVk59zbFF2Sxfyxxmua",
    "importFlowGitNamespace": "Example Name",
    "importFlowGitNamespaceId": "Example Name",
    "importFlowGitProvider": "bitbucket",
    "isAccountUpdateRequired": "false",
    "isEnterpriseManaged": "false",
    "name": "John Doe",
    "preferredScopesAndGitNamespaces": [
      {
        "gitNamespaceId": "Example Name",
        "scopeId": "example_id"
      }
    ],
    "remoteCaching": {
      "enabled": "false"
    },
    "resourceConfig": {
      "awsAccountIds": [],
      "awsAccountType": "string",
      "blobStores": "123",
      "buildEntitlements": {
        "enhancedBuilds": "false"
      },
      "buildQueue": {
        "configuration": "SKIP_NAMESPACE_QUEUE"
      },
      "bulkRedirectsFreeLimitOverride": "123",
      "cfZoneName": "Example Name",
      "concurrentBuilds": "123",
      "cronJobsPerProject": "123",
      "customEnvironmentsPerProject": "123",
      "edgeConfigs": "123",
      "edgeConfigSize": "123",
      "edgeFunctionExecutionTimeoutMs": "123",
      "edgeFunctionMaxSizeBytes": "123",
      "elasticConcurrencyEnabled": "false",
      "flagsExplorerOverridesThreshold": "123",
      "flagsExplorerUnlimitedOverrides": "false",
      "imageOptimizationType": "string",
      "integrationStores": "123",
      "kvDatabases": "123",
      "microfrontendGroupsPerTeam": "123",
      "microfrontendProjectsPerGroup": "123",
      "nodeType": "string",
      "postgresDatabases": "123",
      "security": {
        "customRules": "123",
        "ipBlocks": "123",
        "ipBypass": "123",
        "rateLimit": "123",
        "securityLists": "123",
        "teamLevelConditions": "123",
        "teamLevelRules": "123",
        "teamLevelRulesets": "123"
      },
      "serverlessFunctionMaxDuration": "123",
      "serverlessFunctionMaxMemorySize": "123"
    },
    "shouldShowEnterpriseManagedWelcome": "false",
    "softBlock": {
      "blockedAt": "123",
      "blockedDueToOverageType": "analyticsUsage",
      "reason": "BLOCKED_FOR_PLATFORM_ABUSE",
      "unpauseAt": "123"
    },
    "stagingPrefix": "string",
    "username": "jdoe"
  }
}

OpenAPI Specification