ListFlagsRequest

June 9, 2026 ยท View on GitHub

Example Usage

import { ListFlagsRequest } from "@vercel/sdk/models/listflagsop.js";

let value: ListFlagsRequest = {
  projectIdOrName: "<value>",
  teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  slug: "my-team-url-slug",
};

Fields

FieldTypeRequiredDescriptionExample
projectIdOrNamestring:heavy_check_mark:The project id or name
statemodels.ListFlagsQueryParamState:heavy_minus_sign:The state of the flags to retrieve. Defaults to active.
withMetadataboolean:heavy_minus_sign:Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release. Use GET /v1/projects/:id/feature-flags/flags/:flagIdOrSlug?withMetadata=true for single-flag lookups that need creator metadata.
limitnumber:heavy_minus_sign:Maximum number of flags to return. When not set, all flags are returned.
cursorstring:heavy_minus_sign:Pagination cursor to continue from.
searchstring:heavy_minus_sign:Search flags by their slug or description. Case-insensitive.
tagsstring[]:heavy_minus_sign:Filter flags by tag. Repeat the parameter for multiple tags (all must match).
teamIdstring:heavy_minus_sign:The Team identifier to perform the request on behalf of.team_1a2b3c4d5e6f7g8h9i0j1k2l
slugstring:heavy_minus_sign:The Team slug to perform the request on behalf of.my-team-url-slug