--- title: list-all-teams product: vercel url: /docs/rest-api/teams/list-all-teams type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about list-all-teams on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # List all teams ```http GET /v2/teams ``` Get a paginated list of all the Teams the authenticated User is a member of. ## Authentication **bearerToken**: HTTP bearer ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `limit` | number | No | Maximum number of Teams which may be returned. | | `since` | number | No | Timestamp (in milliseconds) to only include Teams created since then. | | `until` | number | No | Timestamp (in milliseconds) to only include Teams created until then. | ## Responses ### 200: A paginated list of teams. Content-Type: `application/json` ```json { "type": "object", "description": "A paginated list of teams.", "required": [ "pagination", "teams" ], "properties": { "teams": { "type": "array", "items": { "oneOf": [ { "type": "object", "description": "Data representing a Team.", "required": [ "avatar", "createdAt", "creatorId", "description", "id", "membership", "name", "slug", "stagingPrefix", "updatedAt" ], "properties": { "connect": { "type": "object", "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] } } }, "creatorId": { "type": "string", "description": "The ID of the user who created the Team." }, "updatedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the Team was last updated." }, "emailDomain": { "type": "string", "description": "Hostname that'll be matched with emails on sign-up to automatically join the Team.", "nullable": true }, "saml": { "type": "object", "description": "When \"Single Sign-On (SAML)\" is configured, this object contains information regarding the configuration of the Identity Provider (IdP).", "required": [ "enforced" ], "properties": { "connection": { "type": "object", "description": "Information for the SAML Single Sign-On configuration.", "required": [ "connectedAt", "state", "status", "type" ], "properties": { "type": { "type": "string", "description": "The Identity Provider \"type\", for example Okta." }, "status": { "type": "string", "description": "Current status of the connection." }, "state": { "type": "string", "description": "Current state of the connection." }, "connectedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the configuration was connected." }, "lastReceivedWebhookEvent": { "type": "number", "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS." }, "lastSyncedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the last directory sync was performed." }, "syncState": { "type": "string", "description": "Controls whether directory sync events are processed. - 'SETUP': Directory connected but role mappings not yet configured. Events are acknowledged but not processed. - 'ACTIVE': Fully configured. Events are processed normally. - undefined: Legacy directory (pre-feature), treat as 'ACTIVE' for backwards compatibility.", "enum": [ "SETUP", "ACTIVE" ] } } }, "directory": { "type": "object", "description": "Information for the Directory Sync configuration.", "required": [ "connectedAt", "state", "type" ], "properties": { "type": { "type": "string", "description": "The Identity Provider \"type\", for example Okta." }, "state": { "type": "string", "description": "Current state of the connection." }, "connectedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the configuration was connected." }, "lastReceivedWebhookEvent": { "type": "number", "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS." }, "lastSyncedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the last directory sync was performed." }, "syncState": { "type": "string", "description": "Controls whether directory sync events are processed. - 'SETUP': Directory connected but role mappings not yet configured. Events are acknowledged but not processed. - 'ACTIVE': Fully configured. Events are processed normally. - undefined: Legacy directory (pre-feature), treat as 'ACTIVE' for backwards compatibility.", "enum": [ "SETUP", "ACTIVE" ] } } }, "enforced": { "type": "boolean", "description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider.", "enum": [ false, true ] }, "defaultRedirectUri": { "type": "string", "description": "The default redirect URI to use after successful SAML authentication.", "enum": [ "vercel.com", "v0.dev", "v0.app" ] }, "roles": { "type": "object", "description": "When \"Directory Sync\" is configured, this object contains a mapping of which Directory Group (by ID) should be assigned to which Vercel Team \"role\".", "additionalProperties": { "oneOf": [ { "type": "object", "description": "When \"Directory Sync\" is configured, this object contains a mapping of which Directory Group (by ID) should be assigned to which Vercel Team \"role\".", "required": [ "accessGroupId" ], "properties": { "accessGroupId": { "type": "string" } } }, { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } ] } } } }, "inviteCode": { "type": "string", "description": "Code that can be used to join this Team. Only visible to Team owners." }, "description": { "type": "string", "description": "A short description of the Team.", "nullable": true }, "defaultRoles": { "type": "object", "description": "Default roles for the team.", "properties": { "teamRoles": { "type": "array", "items": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } }, "teamPermissions": { "type": "array", "items": { "type": "string", "enum": [ "IntegrationManager", "CreateProject", "FullProductionDeployment", "UsageViewer", "EnvVariableManager", "EnvironmentManager", "V0Builder", "V0Chatter", "V0Viewer" ] } } } }, "stagingPrefix": { "type": "string", "description": "The prefix that is prepended to automatic aliases." }, "resourceConfig": { "type": "object", "properties": { "concurrentBuilds": { "type": "number", "description": "The total amount of concurrent builds that can be used." }, "elasticConcurrencyEnabled": { "type": "boolean", "description": "Whether every build for this team / user has elastic concurrency enabled automatically.", "enum": [ false, true ] }, "edgeConfigSize": { "type": "number", "description": "The maximum size in kilobytes of an Edge Config. Only specified if a custom limit is set." }, "edgeConfigs": { "type": "number", "description": "The maximum number of edge configs an account can create." }, "kvDatabases": { "type": "number", "description": "The maximum number of kv databases an account can create." }, "blobStores": { "type": "number", "description": "The maximum number of blob stores an account can create." }, "postgresDatabases": { "type": "number", "description": "The maximum number of postgres databases an account can create." }, "buildEntitlements": { "type": "object", "properties": { "enhancedBuilds": { "type": "boolean", "enum": [ false, true ] } } }, "buildMachine": { "type": "object", "description": "Build machine configuration", "properties": { "default": { "type": "string", "description": "Default build machine type for new builds", "enum": [ "enhanced", "turbo", "standard", "elastic" ] } } } } }, "previewDeploymentSuffix": { "type": "string", "description": "The hostname that is current set as preview deployment suffix.", "nullable": true }, "platform": { "type": "boolean", "description": "Whether the team is a platform team.", "enum": [ false, true ] }, "disableHardAutoBlocks": { "oneOf": [ { "type": "number" }, { "type": "boolean", "enum": [ false, true ] } ] }, "remoteCaching": { "type": "object", "description": "Is remote caching enabled for this team", "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] } } }, "defaultDeploymentProtection": { "type": "object", "description": "Default deployment protection for this team null indicates protection is disabled", "properties": { "passwordProtection": { "type": "object", "nullable": true, "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string" } } }, "ssoProtection": { "type": "object", "nullable": true, "required": [ "deploymentType" ], "properties": { "deploymentType": { "type": "string" } } } } }, "defaultExpirationSettings": { "type": "object", "description": "Default deployment expiration settings for this team", "properties": { "expirationDays": { "type": "number", "description": "Number of days to keep non-production deployments (mostly preview deployments) before soft deletion." }, "expirationDaysProduction": { "type": "number", "description": "Number of days to keep production deployments before soft deletion." }, "expirationDaysCanceled": { "type": "number", "description": "Number of days to keep canceled deployments before soft deletion." }, "expirationDaysErrored": { "type": "number", "description": "Number of days to keep errored deployments before soft deletion." }, "deploymentsToKeep": { "type": "number", "description": "Minimum number of production deployments to keep for this project, even if they are over the production expiration limit." } } }, "enablePreviewFeedback": { "type": "string", "description": "Whether toolbar is enabled on preview deployments", "enum": [ "default", "on", "off", "on-force", "off-force", "default-force" ], "nullable": true }, "enableProductionFeedback": { "type": "string", "description": "Whether toolbar is enabled on production deployments", "enum": [ "default", "on", "off", "on-force", "off-force", "default-force" ], "nullable": true }, "sensitiveEnvironmentVariablePolicy": { "type": "string", "description": "Sensitive environment variable policy for this team", "enum": [ "default", "on", "off" ], "nullable": true }, "hideIpAddresses": { "type": "boolean", "description": "Indicates if IP addresses should be accessible in observability (o11y) tooling", "enum": [ false, true ], "nullable": true }, "hideIpAddressesInLogDrains": { "type": "boolean", "description": "Indicates if IP addresses should be accessible in log drains", "enum": [ false, true ], "nullable": true }, "ipBuckets": { "type": "array", "items": { "type": "object", "required": [ "bucket" ], "properties": { "bucket": { "type": "string" }, "supportUntil": { "type": "number" } } } }, "strictDeploymentProtectionSettings": { "type": "object", "description": "When enabled, deployment protection settings require stricter permissions (owner-only).", "required": [ "enabled", "updatedAt" ], "properties": { "enabled": { "type": "boolean", "enum": [ false, true ] }, "updatedAt": { "type": "number" } } }, "nsnbConfig": { "type": "object", "description": "NSNB configuration for the team.", "required": [ "preference" ], "properties": { "preference": { "type": "string", "enum": [ "auto-approval", "manual-approval", "block" ] } } }, "id": { "type": "string", "description": "The Team's unique identifier." }, "slug": { "type": "string", "description": "The Team's slug, which is unique across the Vercel platform." }, "name": { "type": "string", "description": "Name associated with the Team account, or `null` if none has been provided.", "nullable": true }, "avatar": { "type": "string", "description": "The ID of the file used as avatar for this Team.", "nullable": true }, "membership": { "type": "object", "description": "The membership of the authenticated User in relation to the Team.", "required": [ "confirmed", "created", "createdAt", "role" ], "properties": { "uid": { "type": "string" }, "entitlements": { "type": "array", "items": { "type": "object", "required": [ "entitlement" ], "properties": { "entitlement": { "type": "string" } } } }, "teamId": { "type": "string" }, "confirmed": { "type": "boolean", "enum": [ true ] }, "accessRequestedAt": { "type": "number" }, "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "teamRoles": { "type": "array", "items": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } }, "teamPermissions": { "type": "array", "items": { "type": "string", "enum": [ "IntegrationManager", "CreateProject", "FullProductionDeployment", "UsageViewer", "EnvVariableManager", "EnvironmentManager", "V0Builder", "V0Chatter", "V0Viewer" ] } }, "createdAt": { "type": "number" }, "created": { "type": "number" }, "joinedFrom": { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "link", "saml", "mail", "import", "teams", "github", "gitlab", "bitbucket", "dsync", "feedback", "organization-teams", "nsnb-auto-approve", "nsnb-hobby-upgrade", "nsnb-request-access", "nsnb-viewer-upgrade", "nsnb-invite", "nsnb-redeploy" ] }, "commitId": { "type": "string" }, "repoId": { "type": "string" }, "repoPath": { "type": "string" }, "gitUserId": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "gitUserLogin": { "type": "string" }, "ssoUserId": { "type": "string" }, "ssoConnectedAt": { "type": "number" }, "idpUserId": { "type": "string" }, "dsyncUserId": { "type": "string" }, "dsyncConnectedAt": { "type": "number" } } } } }, "createdAt": { "type": "number", "description": "UNIX timestamp (in milliseconds) when the Team was created." } }, "additionalProperties": true }, { "type": "object", "description": "A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data.", "required": [ "avatar", "createdAt", "id", "limited", "limitedBy", "membership", "name", "slug" ], "properties": { "limited": { "type": "boolean", "description": "Property indicating that this Team data contains only limited information, due to the authentication token missing privileges to read the full Team data or due to team having MFA enforced and the user not having MFA enabled. Re-login with the Team's configured SAML Single Sign-On provider in order to upgrade the authentication token with the necessary privileges.", "enum": [ true ] }, "limitedBy": { "type": "array", "items": { "type": "string", "enum": [ "mfa", "scope" ] } }, "saml": { "type": "object", "description": "When \"Single Sign-On (SAML)\" is configured, this object contains information that allows the client-side to identify whether or not this Team has SAML enforced.", "required": [ "enforced" ], "properties": { "connection": { "type": "object", "description": "Information for the SAML Single Sign-On configuration.", "required": [ "connectedAt", "state", "status", "type" ], "properties": { "type": { "type": "string", "description": "The Identity Provider \"type\", for example Okta." }, "status": { "type": "string", "description": "Current status of the connection." }, "state": { "type": "string", "description": "Current state of the connection." }, "connectedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the configuration was connected." }, "lastReceivedWebhookEvent": { "type": "number", "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS." }, "lastSyncedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the last directory sync was performed." }, "syncState": { "type": "string", "description": "Controls whether directory sync events are processed. - 'SETUP': Directory connected but role mappings not yet configured. Events are acknowledged but not processed. - 'ACTIVE': Fully configured. Events are processed normally. - undefined: Legacy directory (pre-feature), treat as 'ACTIVE' for backwards compatibility.", "enum": [ "SETUP", "ACTIVE" ] } } }, "directory": { "type": "object", "description": "Information for the Directory Sync configuration.", "required": [ "connectedAt", "state", "type" ], "properties": { "type": { "type": "string", "description": "The Identity Provider \"type\", for example Okta." }, "state": { "type": "string", "description": "Current state of the connection." }, "connectedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the configuration was connected." }, "lastReceivedWebhookEvent": { "type": "number", "description": "Timestamp (in milliseconds) of when the last webhook event was received from WorkOS." }, "lastSyncedAt": { "type": "number", "description": "Timestamp (in milliseconds) of when the last directory sync was performed." }, "syncState": { "type": "string", "description": "Controls whether directory sync events are processed. - 'SETUP': Directory connected but role mappings not yet configured. Events are acknowledged but not processed. - 'ACTIVE': Fully configured. Events are processed normally. - undefined: Legacy directory (pre-feature), treat as 'ACTIVE' for backwards compatibility.", "enum": [ "SETUP", "ACTIVE" ] } } }, "enforced": { "type": "boolean", "description": "When `true`, interactions with the Team **must** be done with an authentication token that has been authenticated with the Team's SAML Single Sign-On provider.", "enum": [ false, true ] } } }, "id": { "type": "string", "description": "The Team's unique identifier." }, "slug": { "type": "string", "description": "The Team's slug, which is unique across the Vercel platform." }, "name": { "type": "string", "description": "Name associated with the Team account, or `null` if none has been provided.", "nullable": true }, "avatar": { "type": "string", "description": "The ID of the file used as avatar for this Team.", "nullable": true }, "membership": { "type": "object", "description": "The membership of the authenticated User in relation to the Team.", "required": [ "confirmed", "created", "createdAt", "role" ], "properties": { "uid": { "type": "string" }, "entitlements": { "type": "array", "items": { "type": "object", "required": [ "entitlement" ], "properties": { "entitlement": { "type": "string" } } } }, "teamId": { "type": "string" }, "confirmed": { "type": "boolean", "enum": [ true ] }, "accessRequestedAt": { "type": "number" }, "role": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] }, "teamRoles": { "type": "array", "items": { "type": "string", "enum": [ "OWNER", "MEMBER", "DEVELOPER", "SECURITY", "BILLING", "VIEWER", "VIEWER_FOR_PLUS", "CONTRIBUTOR" ] } }, "teamPermissions": { "type": "array", "items": { "type": "string", "enum": [ "IntegrationManager", "CreateProject", "FullProductionDeployment", "UsageViewer", "EnvVariableManager", "EnvironmentManager", "V0Builder", "V0Chatter", "V0Viewer" ] } }, "createdAt": { "type": "number" }, "created": { "type": "number" }, "joinedFrom": { "type": "object", "required": [ "origin" ], "properties": { "origin": { "type": "string", "enum": [ "link", "saml", "mail", "import", "teams", "github", "gitlab", "bitbucket", "dsync", "feedback", "organization-teams", "nsnb-auto-approve", "nsnb-hobby-upgrade", "nsnb-request-access", "nsnb-viewer-upgrade", "nsnb-invite", "nsnb-redeploy" ] }, "commitId": { "type": "string" }, "repoId": { "type": "string" }, "repoPath": { "type": "string" }, "gitUserId": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "gitUserLogin": { "type": "string" }, "ssoUserId": { "type": "string" }, "ssoConnectedAt": { "type": "number" }, "idpUserId": { "type": "string" }, "dsyncUserId": { "type": "string" }, "dsyncConnectedAt": { "type": "number" } } } } }, "createdAt": { "type": "number", "description": "UNIX timestamp (in milliseconds) when the Team was created." } } } ] } }, "pagination": { "type": "object", "description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.", "required": [ "count", "next", "prev" ], "properties": { "count": { "type": "number", "description": "Amount of items in the current page." }, "next": { "type": "number", "description": "Timestamp that must be used to request the next page.", "nullable": true }, "prev": { "type": "number", "description": "Timestamp that must be used to request the previous page.", "nullable": true } } } } } ``` ### 400: One of the provided values in the request query is invalid. ### 401: No description ### 403: You do not have permission to access this resource. --- ## Related - [teams endpoints](/docs/rest-api#teams) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)