team_flags

Creates, updates, deletes, gets or lists a team_flags resource.

Overview

Name	team_flags
Type	Resource
Id	vercel.feature_flags.team_flags

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	team_id	state, limit, cursor, search, kind, tags, created_by, maintainer_ids, include_marketplace_flags, slug	Retrieve all feature flags for a team across all projects. Returns an opaque cursor for pagination.
list_v1	exec	team_id	state, withMetadata, limit, cursor, search, kind, tags, slug	Retrieve all feature flags for a team across all projects. The list can be filtered by state and supports pagination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
team_id	string	The Team identifier to perform the request on behalf of.
created_by	string	Filter flags by the id of the entity that created them (a user or team id). (wire: createdBy)
cursor	string	Pagination cursor to continue from.
include_marketplace_flags	boolean	Whether to include Marketplace experimentation items in the paginated response. Defaults to false. (wire: includeMarketplaceFlags)
kind	string	The kind of flags to retrieve.
limit	integer	Maximum number of flags to return.
maintainer_ids	array	Filter flags by maintainer user id. Repeat the parameter for multiple maintainers (any may match). (wire: maintainerIds)
search	string	Search flags by their slug or description. Case-insensitive.
slug	string	The Team slug to perform the request on behalf of.
state	string	The state of the flags to retrieve. Defaults to active.
tags	array	Filter flags by tag. Repeat the parameter for multiple tags (all must match).
withMetadata	boolean	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.

SELECT examples

list

Retrieve all feature flags for a team across all projects. Returns an opaque cursor for pagination.

SELECT
*
FROM vercel.feature_flags.team_flags
WHERE team_id = '{{ team_id }}' -- required
AND state = '{{ state }}'
AND limit = '{{ limit }}'
AND cursor = '{{ cursor }}'
AND search = '{{ search }}'
AND kind = '{{ kind }}'
AND tags = '{{ tags }}'
AND created_by = '{{ created_by }}'
AND maintainer_ids = '{{ maintainer_ids }}'
AND include_marketplace_flags = '{{ include_marketplace_flags }}'
AND slug = '{{ slug }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

list_v1

Retrieve all feature flags for a team across all projects. The list can be filtered by state and supports pagination.

EXEC vercel.feature_flags.team_flags.list_v1 
@team_id='{{ team_id }}' --required, 
@state='{{ state }}', 
@withMetadata={{ withMetadata }}, 
@limit='{{ limit }}', 
@cursor='{{ cursor }}', 
@search='{{ search }}', 
@kind='{{ kind }}', 
@tags='{{ tags }}', 
@slug='{{ slug }}'
;