List User Events | Vercel REST API

APIs & SDKs

List User Events

GEThttps://api.vercel.com/v3/events

Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

https://api.vercel.com/v3/events

const response = await fetch('https://api.vercel.com/v3/events?limit=123&since=string&until=string&types=string&userId=string&principalId=string&projectIds=string&entityId=string&withPayload=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "events": [
    {
      "categories": [],
      "createdAt": "1632859321020",
      "entities": [
        {
          "end": "3",
          "start": "0",
          "type": "author"
        }
      ],
      "id": "uev_bfmMjiMnXfnPbT97dGdpJbCN",
      "payload": "value",
      "principal": {
        "avatar": "string",
        "email": "user@example.com",
        "slug": "string",
        "type": "user",
        "uid": "example_id",
        "username": "string"
      },
      "principalId": "example_id",
      "requestId": "example_id",
      "sessionId": "example_id",
      "text": "You logged in via GitHub",
      "tokenId": "example_id",
      "type": "login",
      "user": {
        "avatar": "string",
        "email": "user@example.com",
        "slug": "string",
        "uid": "example_id",
        "username": "string"
      },
      "userId": "zTuNVUXEAvvnNN3IaqinkyMw",
      "via": [
        {
          "avatar": "string",
          "email": "user@example.com",
          "slug": "string",
          "type": "user",
          "uid": "example_id",
          "username": "string"
        }
      ],
      "viaIds": []
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

limitnumberOptional

Maximum number of items which may be returned.

sincestringOptional

Timestamp to only include items created since then.

untilstringOptional

Timestamp to only include items created until then.

typesstringOptional

Comma-delimited list of event "types" to filter the results by.

userIdstringOptional

Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.

principalIdstringOptional

When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.

projectIdsstringOptional

Comma-delimited list of project IDs to filter the results by.

entityIdstringOptional

Filters events to those associated with a specific entity (matched against payload.id). For example, a connector ID.

withPayloadstringOptional

When set to true, the response will include the payload field for each event.

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Successful response.

eventsarrayRequired

Array of events generated by the User.

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

410Error

Cross-link map: List User Events (/docs/rest-api/user/list-user-events)

From the Vercel docs graph (built 2026-10-14T10:24:21.026Z), 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

List Event Types — GET /v1/events/types — Returns the list of user-facing event types with descriptions.
Update the microfrontends settings — PATCH /v1/projects/{projectId}/microfrontends — Update the microfrontends settings for a project.
List projects in a microfrontends group — GET /v1/microfrontends/groups/{groupId}/projects — Get the microfrontends for a given group ID.
Using the Activity Log — Learn how to use the Activity Log, which provides a list of all events on a team, chronologically organized since its cr
Delete a project avatar — DELETE /v1/projects/{idOrName}/avatar — Remove the avatar of the project identified by \idOrName\\. Deletes the chosen

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/v3/events

const response = await fetch('https://api.vercel.com/v3/events?limit=123&since=string&until=string&types=string&userId=string&principalId=string&projectIds=string&entityId=string&withPayload=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "events": [
    {
      "categories": [],
      "createdAt": "1632859321020",
      "entities": [
        {
          "end": "3",
          "start": "0",
          "type": "author"
        }
      ],
      "id": "uev_bfmMjiMnXfnPbT97dGdpJbCN",
      "payload": "value",
      "principal": {
        "avatar": "string",
        "email": "user@example.com",
        "slug": "string",
        "type": "user",
        "uid": "example_id",
        "username": "string"
      },
      "principalId": "example_id",
      "requestId": "example_id",
      "sessionId": "example_id",
      "text": "You logged in via GitHub",
      "tokenId": "example_id",
      "type": "login",
      "user": {
        "avatar": "string",
        "email": "user@example.com",
        "slug": "string",
        "uid": "example_id",
        "username": "string"
      },
      "userId": "zTuNVUXEAvvnNN3IaqinkyMw",
      "via": [
        {
          "avatar": "string",
          "email": "user@example.com",
          "slug": "string",
          "type": "user",
          "uid": "example_id",
          "username": "string"
        }
      ],
      "viaIds": []
    }
  ]
}

OpenAPI Specification