List deployments with the Vercel API

Lists deployments, newest first, with state, target, url and Git metadata. Each item has uid, the id of the deployment. Paginate passing pagination.next of the response as until.

Identifier
vercel_list_deployments

The request

POST https://connect.reportei.com/api/tools/vercel_list_deployments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "teamId": "<teamId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoWith a Full Account token, the id of a team from List teams, to act on that team. Omit it for the personal account or with a team token.
projectIdstringNoOnly deployments of this project: its id or name, from List projects.
targetstringNoOnly deployments of this environment, such as production or preview.
statestringNoComma-separated states: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED or BLOCKED. Example: BUILDING,READY.
branchstringNoOnly deployments of this Git branch.
shastringNoOnly deployments of this Git commit.
limitnumberNoMaximum number of deployments to return.
sincenumberNoOnly deployments created after this time, in milliseconds since 1970.
untilnumberNoOnly deployments created before this time, in milliseconds since 1970. For the next page, the pagination.next of the previous response.

Supported connections

Your customer connects their Vercel account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/vercel_list_deployments. It becomes your agent's tool definition with no conversion.

Other Vercel tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.