Skip to content
Docs

List invocations for a team, optionally filtered by repository and invocation metadata

GEThttps://api.vercel.com/v2/vercel-ci/invocations
List Invocations
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.vercelCi.listVercelCiInvocations({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "invocations": [
    {
      "invocationId": "example_id",
      "attempt": "123",
      "teamId": "example_id",
      "source": {
        "type": "string"
      },
      "createdAt": "123",
      "repositoryKey": "string",
      "ref": "string",
      "commitSha": "string",
      "skipped": {
        "reason": "Customer requested refund"
      },
      "bootstrappingStarted": {
        "startedAt": "123"
      },
      "bootstrappingFailed": {
        "reason": "Customer requested refund"
      },
      "sandboxSnapshotted": {
        "sandboxSnapshotId": "example_id",
        "workingDirectory": "string",
        "snapshottedAt": "123"
      },
      "sandboxNamed": {
        "sandboxName": "Example Name",
        "workingDirectory": "string",
        "readyAt": "123"
      },
      "jobDefinitionsCreated": {
        "names": [],
        "source": "string",
        "scheduledAt": "123"
      },
      "completed": {
        "completedAt": "123",
        "conclusion": "string"
      },
      "setupConclusion": {
        "result": "string"
      },
      "runConclusion": {
        "result": "string"
      },
      "status": "string"
    }
  ],
  "repositories": "value",
  "pagination": {
    "nextCursor": "string"
  }
}
Errors
{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

providerstringOptional
Repository provider (e.g., "github").
repositorystringOptional
Repository slug (e.g., "vercel/next.js").
branchNamestringOptional
Branch name (e.g., "main").
snapshotstringOptional
Snapshot/commit hash.
statusarrayOptional
conclusionarrayOptional
sourcearrayOptional
authorGitHubIdstringOptional
authorstringOptional
GitHub author login.
createdAfternumberOptional
createdBeforenumberOptional
limitnumberOptional
Number of results per page (default: 20, max: 100).
cursorstringOptional
Pagination cursor from a previous response.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Successfully listed invocations.
invocationsarrayRequired
repositoriesobjectRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
errorobjectRequired
403You do not have permission to access this resource.
errorobjectRequired
404Error
410Error
429Error
errorobjectRequired
500Error
errorobjectRequired
503Error