projects

Retrieve a list of projects

Changed on

Allows to retrieve the list of projects of the authenticated user or team. The list will be paginated and the provided query parameters allow filtering the returned projects.

get/v10/projects

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v10/projects
  • Auth: HTTP bearer

Query parameters

fromstring

Query only projects updated after the given timestamp or continuation token.

sincenumber

Query only projects updated after this JavaScript timestamp.

Example:1540095775941
untilnumber

Query only projects updated before this JavaScript timestamp.

Example:1540095775951
gitForkProtection'1' | '0'

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

Example:1
limitstring

Limit the number of projects returned

searchstring

Search projects by the name field

repostring

Filter results by repo. Also used for project count

repoIdstring

Filter results by Repository ID.

repoUrlstring

Filter results by Repository URL.

Example:https://github.com/vercel/next.js
excludeReposstring

Filter results by excluding those projects that belong to a repo

edgeConfigIdstring

Filter results by connected Global Config ID

edgeConfigTokenIdstring

Filter results by connected Global Config Token ID

deprecatedboolean
elasticConcurrencyEnabled'1' | '0'

Filter results by projects with elastic concurrency enabled

Example:1
staticIpsEnabled'0' | '1'

Filter results by projects with Static IPs enabled

Example:1
buildMachineTypesstring

Filter results by effective build machine types. Accepts comma-separated values. Use "elastic" for projects with elastic selection and "default" for projects without a build machine type set.

Example:default,enhanced
buildQueueConfiguration'SKIP_NAMESPACE_QUEUE' | 'WAIT_FOR_NAMESPACE_QUEUE'

Filter results by build queue configuration. SKIP_NAMESPACE_QUEUE includes projects without a configuration set.

Example:SKIP_NAMESPACE_QUEUE
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

OR
OR

Example response

[
  {
    "rollingRelease": {
      "gate": {
        "checks": [
          {
            "excludePaths": [
              "/api/health"
            ],
            "excludeStatusCodes": [
              503
            ],
            "ingestWatermarkSeconds": 30,
            "significanceLevel": 0.05
          }
        ],
        "failureThreshold": 3,
        "windowSize": 5
      },
      "stages": [
        {
          "duration": 600,
          "targetPercentage": 25
        }
      ],
      "target": "production"
    }
  }
]

Changes

  • 2060b55dc517Revision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status

  • 6c0e780b096eRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status