[BETA] Create a signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new signal endpoint.
ActionTry it
Integrate Unleash
with your AI CRM
Unleash is a feature management platform for creating, configuring, and governing feature flags across projects and environments.
Explore Triggers and Actions
[BETA] Create a signal endpoint token for a specific signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new signal endpoint token for a specific signal endpoint, identified by its ID. The response may contain a one-time authentication token; store it securely and never log it.
ActionTry it
[BETA] Create an action set
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new action set.
ActionTry it
[BETA] Delete a signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing signal endpoint identified by its id.
ActionTry it
[BETA] Delete a signal endpoint token
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing signal endpoint token identified by its id.
ActionTry it
[BETA] Delete an action set
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing action set identified by its id.
ActionTry it
[BETA] Disconnect all clients
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Disconnects all streaming clients.
ActionTry it
[BETA] Get aggregated metered connections for a given time period
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Gets metered connections count for the selected period, either aggregated by day or by month.
ActionTry it
[BETA] Get aggregated metered requests for a given time period
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Gets metered requests count for the selected period, either aggregated by day or by month.
ActionTry it
[BETA] List action sets
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns the list of all action sets.
ActionTry it
[BETA] List events for an action set
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of action events triggered by a specific action set, identified by its id.
ActionTry it
[BETA] List signal endpoints
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of all configured signal endpoints.
ActionTry it
[BETA] List signals
**[BETA]** Returns one page of signals in the requested creation-date range. The API may change or be removed; pass next_cursor unchanged to continue the same query.
ActionTry it
[BETA] List signals from a specific signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of signals originated from a specific signal endpoint, identified by its id.
ActionTry it
[BETA] List tokens for a specific signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of all configured signal endpoint tokens for a specific signal endpoint, identified by its id.
ActionTry it
[BETA] Update a signal endpoint
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Updates an existing signal endpoint identified by its id.
ActionTry it
[BETA] Update a signal endpoint token
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Updates an existing signal endpoint token identified by its id.
ActionTry it
[BETA] Update an action set
**[BETA]** This API is in beta state, which means it may change or be removed in the future. Updates an existing action set identified by its id.
ActionTry it
Add a feature dependency
Add a dependency to a parent feature. Each environment will resolve corresponding dependency independently.
ActionTry it
Add a release plan
Adds a release plan to a specific feature flag and environment.
ActionTry it
Add an environment to a project
Associate one existing environment with a project, optionally configure change requests, and optionally create the default activation strategy used when enabling feature flags in that project environment.
ActionTry it
Add and remove tags across features
Add and remove the supplied tags on every listed feature in a project, creating added tags when needed. Both tags.addedTags and tags.removedTags are required and may be empty; additions are applied before removals.
ActionTry it
Add environments to a project
Sequentially associate multiple environments with one project after rejecting duplicates and existing associations. On the first failure, attempts to remove only additions acknowledged during this run in reverse order. This is a non-atomic compensating workflow that can execute deletions; the response reports forward progress, cleanup attempts, cleanup failures, and possible partial state. A definitive 4xx rejects the failed item, while a 5xx or transport failure leaves that item's outcome unknown because Unleash may have committed it.
ActionTry it
Add feature dependencies
Add multiple parent dependencies to one child feature flag in order. The action rejects existing dependencies before mutation and compensates a failed batch in reverse order by deleting additions made during this run. This non-atomic compensating workflow can execute deletions; inspect complete, partial_state, failed_item_outcome, and rollback_failures. A definitive 4xx rejects the failed item, while a 5xx or transport failure leaves its outcome unknown because Unleash may have committed it.
ActionTry it
Add Feature Strategy
Add one activation strategy configuration to a feature flag in an environment.
ActionTry it
Approve a user access request
Approves a pending user access request, creating a new user with the specified role.
ActionTry it
Archive a release template
Archives a global release template or a template scoped to one project. The project branch is a beta API.
ActionTry it
Archive Feature
Archive a feature flag in a project. The feature can be revived in Unleash, but revival is not performed by this action.
ActionTry it
Archives a list of features
This endpoint archives the specified features. Any features that are already archived or that don't exist are ignored. All existing features (whether already archived or not) that are provided must belong to the specified project.
ActionTry it
Batch evaluate an Unleash context against a set of environments and projects
Use the provided `context`, `environments`, and `projects` to evaluate toggles on this Unleash instance. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to. The response also contains the input parameters that were provided.
ActionTry it
Change password for a user
Immediately replaces a user's password as an administrator. Treat credentials as secrets and never log them.
ActionTry it
Change specific properties of a strategy
Change specific properties of a strategy configuration in a feature flag.
ActionTry it
Change your own password
Immediately replaces the connected user's password after verifying the old password and confirmation. Treat credentials as secrets and never log them.
ActionTry it
Check dependencies exist
Check if any dependencies exist in this Unleash instance
ActionTry it
Clone a feature flag
Creates a copy of the specified feature flag. The copy can be created in any project.
ActionTry it
Clones an environment
Given an existing environment name and a set of options, this will create a copy of that environment
ActionTry it
Configure project access
Configure project access for groups and single users. The provided users and groups will be given the roles specified in the payload.
ActionTry it
Create (overwrite) variants for a feature flag in multiple environments
Replace the feature flag's complete variant list in every environment named by environments. The same list is written to all targets; an empty variants list removes all variants from every named environment.
ActionTry it
Create (overwrite) variants for a feature in an environment
Replace the feature flag's complete variant list in one environment. An empty variants list removes all variants. If variants are supplied, at least one must use variable weight; fixed weights must total less than 1000, and Unleash distributes the remainder among variable-weight variants.
ActionTry it
Create a banner
Creates a new banner.
ActionTry it
Create a feature link
Create a new link for a feature.
ActionTry it
Create a new addon
Create an external event integration. If enabled is true, Unleash starts sending the selected project and environment events to the configured external provider; create it disabled to configure delivery without starting it.
ActionTry it
Create a new group
Creates an Enterprise user group for role-based access control, with optional SSO mappings, predefined root role, and initial user membership.
ActionTry it
Create a new personal access token (PAT) for the current user
Creates a new [personal access token](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens (PAT) belonging to the current user. The response may contain secret material that is shown only when issued; store it securely and never log it.
ActionTry it
Create a new role
Create a new custom role for Role-Based Access Control.
ActionTry it
Create a new tag
Create a new tag with the specified data.
ActionTry it
Create a new user
Creates a new user with the given root role. By default, Unleash sends the user an irreversible welcome email containing a login link; set send_email=false to suppress it.
ActionTry it
Create a project API token
Create an API token scoped to the specified project. The response can reveal the token secret only when issued; store it securely and never log it.
ActionTry it
Create a public signup token
Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the `Viewer` role. The response may contain secret material that is shown only when issued; store it securely and never log it.
ActionTry it
Create a release template
Creates and returns a release template with its name, optional nullable description, and optional milestone configuration. Project scope uses a beta API.
ActionTry it
Create a service account
Creates a new service account.
ActionTry it
Create a strategy
Creates a custom strategy type based on the supplied data.
ActionTry it
Create a tag type
Create a new tag type.
ActionTry it
Create a token for a service account
Creates a new token for the service account identified by the id. The response may contain secret material that is shown only when issued; store it securely and never log it.
ActionTry it
Create an application to connect reported metrics
Create an application record with its loaded activation strategies and optional URL, color, and icon metadata. This operation does not report an SDK name or version.
ActionTry it
Create API token
Create a backend, frontend, or deprecated client API token with optional project, environment, and expiry restrictions. The response can reveal the token secret only when issued; store it securely and never log it.
ActionTry it
Create Context Field
Create a root context field or a project context field. The project scope uses Unleash's beta project-context API.
ActionTry it
Create Feature
Create a feature flag in a project without enabling it in any environment.
ActionTry it
Create or update a milestone progression
Creates or updates a milestone progression by source milestone ID. If a progression with the given source milestone exists, it will be updated; otherwise, a new one will be created.
ActionTry it
Create or update safeguard
Create or update a metric-threshold safeguard for a feature environment or for one release plan. Set target to release_plan and provide plan_id for a release-plan safeguard; omit plan_id for feature_environment. Returns the saved safeguard and its ID for DELETE_SAFEGUARD.
ActionTry it
Create project
Create a new [Unleash project](https://docs.getunleash.io/concepts/projects).
ActionTry it
Create Segment
Create a reusable segment from a name and complete constraint list.
ActionTry it
Create/Add change to a change request
Add one or more typed changes to the caller's existing draft change request for the project environment, or create a draft when none exists.
ActionTry it
Creates a new environment
Uses the details provided in the payload to create a new environment
ActionTry it
Delete a banner
Deletes an existing banner identified by its id.
ActionTry it
Delete a custom role
Delete a custom role by id. You cannot delete built-in roles or roles that are in use. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete a feature dependency
Remove one named parent feature dependency from a child feature flag.
ActionTry it
Delete a feature link
Delete a feature link by id.
ActionTry it
Delete a milestone progression
Deletes an existing milestone progression by source milestone ID.
ActionTry it
Delete a personal access token (PAT) for the current user
Permanently and immediately revoke one personal access token belonging to the current user by its numeric PAT ID. The credential stops authenticating at once. Composio cannot compare its opaque connection credential with provider token IDs, so the caller must independently verify that this PAT does not back the current Composio connection and explicitly confirm that check.
ActionTry it
Delete a release plan
Delete a release plan from a specific feature flag and environment.
ActionTry it
Delete a release template
Permanently deletes a global release template or a template scoped to one project. The project branch is a beta API.
ActionTry it
Delete a service account
Deletes an existing service account identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete a single group
Delete a single user group by group id. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete a strategy
Deletes the specified strategy definition
ActionTry it
Delete a tag
Delete a tag by type and value. When a tag is deleted all references to the tag are removed.
ActionTry it
Delete a tag type
Deletes a tag type. If any features have tags of this type, those tags will be deleted.
ActionTry it
Delete a token for a service account
Permanently and immediately revoke one service account token by service account ID and token ID. Workloads using that credential lose authentication immediately and cannot recover the deleted token. Composio cannot compare its opaque connection credential with provider token IDs, so the caller must independently verify that this token does not back the current Composio connection and explicitly confirm that check.
ActionTry it
Delete a user
Deletes the user with the given userId. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete all SCIM groups
Deletes all groups managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete all SCIM users
Deletes all users managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Delete an addon
Delete the addon specified by the ID in the request path.
ActionTry it
Delete an application
Delete the application specified in the request URL. Returns 200 OK if the application was successfully deleted or if it didn't exist
ActionTry it
Delete an environment
Delete an environment identified by name.
ActionTry it
Delete Context Field
Permanently delete a root or project context field without removing its existing use in strategy configuration. The project scope uses Unleash's beta project-context API.
ActionTry it
Delete Context Field Legal Value
Permanently delete a legal value from a root or project context field without removing its existing use in constraints. The project scope uses Unleash's beta project-context API.
ActionTry it
Delete feature dependencies
Remove all parent feature dependencies from one child feature flag.
ActionTry it
Delete Feature Strategy
Permanently delete one activation strategy instance from a feature flag in an environment.
ActionTry it
Delete impact metric configuration
Permanently delete one impact metric chart configuration by config_id from the instance-level collection or from one feature flag.
ActionTry it
Delete project
Permanently delete the provided project. All feature flags in the project must be archived before you can delete it. This permanently deletes the project and its archived flags. It can not be undone.
ActionTry it
Delete safeguard
Permanently delete one safeguard by safeguard_id from a feature environment or from one release plan. Set target to release_plan and provide plan_id for a release-plan safeguard; omit plan_id for feature_environment.
ActionTry it
Delete Segment
Permanently delete a segment by numeric ID. Unleash rejects deletion while the segment is in use.
ActionTry it
Deletes a change request by id
This endpoint will delete one change request if it matches the provided id.
ActionTry it
Deletes a list of features
Permanently this endpoint deletes the specified features, that are in archive.
ActionTry it
Deletes an archived feature
Permanently this endpoint deletes the specified feature if it is archived. If the feature is not archived, it is left unchanged.
ActionTry it
Deletes inactive users
Deletes only the explicitly supplied IDs of users who have not logged in during the last 180 days. It does not delete every inactive user automatically. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Discards a change from a change request by change id
This endpoint will discard one change from a change request if it matches the provided id.
ActionTry it
Edits a single change in a change request
Replace one change in a change request. Unleash removes the selected change and inserts the typed replacement, so its old change ID becomes invalid; use the returned request's latest change ID for subsequent edits.
ActionTry it
Enable or disable maintenance mode
Enable or disable maintenance mode for the entire Unleash instance. Enabling it makes the instance mostly read-only and blocks all users from changing configuration. The effect is reversible: disabling maintenance mode restores configuration writes without undoing existing configuration.
ActionTry it
Evaluate an Unleash context against a change request preview
Use the provided `context` to evaluate toggles on this Unleash instance with a change request applied in preview mode. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to.
ActionTry it
Export feature flags from an environment
Export feature flag configuration from one environment, selecting by exactly one of feature names, tag, or project. The result contains feature definitions and strategies plus applicable environment configuration, context fields, tags, tag types, segments, dependencies, and links. Results are JSON; download_file=true delivers that JSON as a downloadable file, not CSV.
ActionTry it
Generate user password-reset URL
Generates and returns a password-reset URL for the user identified by email; it does not change the password. Treat the returned URL as secret material: store it securely and never log it.
ActionTry it
Generates a new SCIM API token
Generates a new SCIM API token. Previously generated tokens will be invalidated. The response may contain secret material that is shown only when issued; store it securely and never log it.
ActionTry it
Get a list of all flag creators for a project
This endpoint returns every user who created a flag in the project.
ActionTry it
Get a list of all users that have created events
Returns a list of all users that have created events in the system.
ActionTry it
Get a list of groups
Get a list of user groups for Role-Based Access Control.
ActionTry it
Get a list of roles
Get a list of project, root and custom roles for Role-Based Access Control.
ActionTry it
Get a release template
Returns a global release template or a template scoped to one project. The project branch is a beta API.
ActionTry it
Get a single group
Get a single user group by group id.
ActionTry it
Get a single role
Get a single role by role id.
ActionTry it
Get a specific addon
Retrieve information about the addon whose ID matches the ID in the request URL.
ActionTry it
Get a strategy configuration
Get a strategy configuration for an environment in a feature flag.
ActionTry it
Get a strategy definition
Retrieves the definition of the strategy specified in the URL
ActionTry it
Get a tag by type and value
Get a tag by type and value. Can be used to check whether a given tag already exists in Unleash or not.
ActionTry it
Get a tag type
Get a tag type by name.
ActionTry it
Get aggregated traffic data for a given time period
Gets traffic usage data for the selected period, either aggregated by day or by month.
ActionTry it
Get all addons and providers
Retrieve all addons and providers that are defined on this Unleash instance.
ActionTry it
Get all applications
Returns one page of applications across the Unleash instance or for one project, with a route-bound cursor for continuation.
ActionTry it
Get all banners
Returns a list of all configured banners.
ActionTry it
Get all environments
Retrieves all environments that exist in this Unleash instance.
ActionTry it
Get all feature types
Retrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes.
ActionTry it
Get all features lifecycle stage count
Return instance-wide feature flag counts grouped into the initial, pre-live, live, completed, and archived lifecycle stages. Each value is the number of feature flags currently in that stage.
ActionTry it
Get all login events
Return all login and logout events in the Unleash system as structured JSON, including success, client, and failure details when available.
ActionTry it
Get all pending user access requests
Returns a list of all pending user access requests.
ActionTry it
Get all personal access tokens (PATs) for the current user
Returns all of the [personal access tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens) (PATs) belonging to the current user. Treat token or credential values as secrets and never log them.
ActionTry it
Get all tag types
Get a list of all available tag types.
ActionTry it
Get all tags for a feature
Retrieves all the tags for a feature name. If the feature does not exist it returns an empty list.
ActionTry it
Get all users and [root roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)
Will return all users and all available root roles for the Unleash instance.
ActionTry it
Get an overview of a project
This endpoint returns an overview of the specified projects stats, project health, number of members, which environments are configured, and the features types in the project.
ActionTry it
Get api tokens for project
Returns the project-specific [API tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys) that have been created for this project.
ActionTry it
Get application data
Returns data about the specified application (`appName`). The data contains information on the name of the application, sdkVersion (which sdk reported these metrics, typically `unleash-client-node:3.4.1` or `unleash-client-java:7.1.0`), as well as data about how to display this application in a list.
ActionTry it
Get application environment instances (Last 24h)
Returns an overview of the instances for the given `appName` and `environment` that have received traffic in the last 24 hours.
ActionTry it
Get application overview
Return an application's projects, feature count, environment and SDK activity, and missing-feature, outdated-SDK, or missing-strategy issues.
ActionTry it
Get basic user and group information
Get a subset of user and group information eligible even for non-admin users.
ActionTry it
Get Context Field
Get one root or project context field by name. The project scope uses Unleash's beta project-context API.
ActionTry it
Get Detailed Invoices
Return detailed Enterprise billing data: plan price and currency plus invoice dates, totals, tax, status, invoice links, primary package or seat line items, and usage, consumption, or overage line items.
ActionTry it
Get Feature
Get one feature flag with its metadata, lifecycle, dependencies, tags, environment enablement, and strategy configurations.
ActionTry it
Get Feature Environment
Get a feature flag's enablement state, complete strategy configurations, variants, release plans, and safeguards in one environment.
ActionTry it
Get feature flag strategies
Get strategies defined for a feature flag in the specified environment.
ActionTry it
Get feature lifecycle
Return the selected feature flag's lifecycle history, including each recorded stage, when the feature entered it, and any detailed stage status. Use this instead of the feature-detail read when the full sequence of lifecycle transitions is needed rather than only the current lifecycle state.
ActionTry it
Get feature metrics
Get usage metrics for a specific feature for the last 48 hours, grouped by hour
ActionTry it
Get instance information
Gets high level information about the usage of this Unleash instance, including user, project, and flag information.
ActionTry it
Get licensed user statistics
Return the available seat count, current license usage, and monthly licensed-user count history for this Unleash instance.
ActionTry it
Get lifecycle trends
Gets lifecycle trends information showing feature flag progression across development, production, and cleanup stages.
ActionTry it
Get maintenance mode status
Tells you whether maintenance mode is enabled or disabled
ActionTry it
Get OIDC auth settings
Returns the current settings for OIDC Authentication.
ActionTry it
Get Plausible analytics data
Fetches analytics data from Plausible API for favorite events over the last 7 days.
ActionTry it
Get project status
This endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data.
ActionTry it
Get project-role mappings
For the provided role, retrieves a list of projects that use this role. For each project it also contains information about how the role used in that project, such as how many users, groups, or service accounts that use the role.
ActionTry it
Get remote MCP server settings
Returns the current settings for the remote MCP server.
ActionTry it
Get SAML auth settings
Returns the current settings for SAML authentication.
ActionTry it
Get scheduled change requests matching a query
List scheduled change requests that touch the supplied feature flag name or activation strategy ID. At least one criterion is required; when both are supplied, Unleash returns requests matching either criterion.
ActionTry it
Get SCIM settings
Returns the current settings for SCIM provisioning.
ActionTry it
Get Segment
Get one reusable segment and its complete constraint definition by numeric ID.
ActionTry it
Get Simple auth settings
Is simple authentication (username/password) enabled for this server.
ActionTry it
Get strategies that use a context field
Retrieves strategies using a root context field or a project context field. A missing context field returns an empty strategy list; the project branch is a beta API.
ActionTry it
Get telemetry settings
Provides the configured settings for [telemetry information collection](https://docs.getunleash.io/privacy-and-compliance/data-privacy)
ActionTry it
Get the environment with `name`
Retrieves the environment with `name` if it exists in this Unleash instance
ActionTry it
Get the external impact-metrics source
Returns the current configuration of the external impact-metrics source (any Prometheus-compatible endpoint).
ActionTry it
Get the number of change requests you can do something with
Returns the number of change requests in this project that your user can move into the next stage by approving or applying them.
ActionTry it
Get total count of admin accounts
Get a total count of admins with password, without password and admin service accounts.
ActionTry it
Get user
Will return a single user by id.
ActionTry it
Get users and groups in project
Get all groups, users and their roles, and available roles for the given project.
ActionTry it
Get variants for a feature in an environment
Returns the variants for a feature in a specific environment. If the feature has no variants it will return an empty array of variants
ActionTry it
Get your own user details
Detailed information about the current user, user permissions and user feedback.
ActionTry it
Get your own user profile
Detailed information about the current user root role and project membership.
ActionTry it
Gets access overview
Gets an overview of what access all users have to all projects and groups.
ActionTry it
Gets usage data
Gets usage data per app/endpoint from a prometheus compatible metrics endpoint
ActionTry it
Import feature flags
Import exported JSON feature flag configuration into the target project and environment. This can create or replace feature definitions, strategies, variants, tags, dependencies, context-field references, and environment state; when change requests are enabled, Unleash creates a draft change request instead of applying changes immediately.
ActionTry it
Instance usage statistics
Provides statistics about various features of Unleash to allow for reporting of usage for self-hosted customers. The response contains data such as the number of users, groups, features, strategies, versions, etc.
ActionTry it
Instance usage statistics
Download a CSV file of self-hosted instance usage statistics, including counts and version data for users, groups, feature flags, and strategies.
ActionTry it
Last hour of usage and a list of applications that have reported seeing this feature flag
Separate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour
ActionTry it
List all tags
List all tags available in Unleash.
ActionTry it
List all tags of a given type
List all tags of a given type. If the tag type does not exist it returns an empty list.
ActionTry it
List all tokens for a service account
Returns the list of all tokens for a service account identified by the id. Treat token or credential values as secrets and never log them.
ActionTry it
List API tokens
Retrieves all API tokens that exist in the Unleash instance. Treat token or credential values as secrets and never log them.
ActionTry it
List API tokens by name
Retrieves all API tokens that match a given token name. Because token names are not unique, this endpoint will always return a list. If no tokens with the provided name exist, the list will be empty. Otherwise, it will contain all the tokens with the given name. Treat token or credential values as secrets and never log them.
ActionTry it
List available change request reviewers
List users who are available to review or approve a change request in the specified project environment.
ActionTry it
List available impact metrics
Returns all available impact metrics and their metadata.
ActionTry it
List available permissions
Returns a list of available permissions.
ActionTry it
List change requests for a project
This endpoint will retrieve all change requests regardless of status for a given project. There's an upper limit of last 300 change requests ordered by creation date.
ActionTry it
List Context Fields
List configured root context fields or project context fields. The project scope uses Unleash's beta project-context API.
ActionTry it
List Features
List every feature flag in one project with its high-level state in each environment.
ActionTry it
List impact metric configurations
List impact metric chart configurations for either the Unleash instance (not associated with a feature flag) or one feature flag.
ActionTry it
List inactive users
Gets all inactive users. An inactive user is a user that has not logged in in the last 180 days.
ActionTry it
List integration events for a specific integration configuration
Returns a list of integration events belonging to a specific integration configuration, identified by its id.
ActionTry it
List invoices
Return Enterprise invoice summaries for billing review, including formatted amount due, paid state, current status, optional due date, and links to view or download each invoice as PDF. Use GET_DETAILED_INVOICES when plan pricing and line-item breakdowns are needed.
ActionTry it
List notifications
A user may get relevant notifications from the projects they are a member of
ActionTry it
List outdated SDKs
Lists outdated SDK versions and the applications using them across the instance or in one project.
ActionTry it
List parent feature variants
List available parent variants across all strategy variants and feature environment variants.
ActionTry it
List parent options
List available parents who have no transitive dependencies.
ActionTry it
List pending change requests referencing a feature
This endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name.
ActionTry it
List Project Environments
List environments available to a project with project-specific visibility and enabled-toggle counts.
ActionTry it
List Projects
List projects available to the connected Admin API principal, optionally including archived projects.
ActionTry it
List public signup tokens
Retrieves all existing public signup tokens. Treat token or credential values as secrets and never log them.
ActionTry it
List release plans
Returns a list of all release plans for a specific feature flag and environment.
ActionTry it
List release templates
Lists global release templates or templates for one project. The project branch is a beta API; set include_global to include global templates with project results.
ActionTry it
List requested change request reviewers
Get the users currently requested to review a change request. These are requested reviewers, not users who have already approved it.
ActionTry it
List roles for the currently logged-in user
Gets roles assigned to currently logged in user. Both explicitly and transitively through group memberships.
ActionTry it
List Segments
List all reusable segments in the Unleash instance with their constraints and usage counts.
ActionTry it
List service accounts
Returns the list of all service accounts.
ActionTry it
List strategies that reference a segment
Retrieve all strategies that reference the specified segment.
ActionTry it
List strategy segments
Retrieve all segments that are referenced by the specified strategy. Returns an empty list of segments if the strategy ID doesn't exist.
ActionTry it
List Strategy Types
List predefined and custom strategy types available for feature configuration.
ActionTry it
List unknown flags
Returns a list of unknown flag reports from the last 24 hours, if any. Maximum of 1000.
ActionTry it
Mark features as stale / not stale
This endpoint marks the provided list of features as either [stale](https://docs.getunleash.io/concepts/technical-debt#stale-and-potentially-stale-flags) or not stale depending on the request body you send. Any provided features that don't exist are ignored.
ActionTry it
Mark notifications as read
Allow to select which notifications were read and saving a read date
ActionTry it
Modify a feature flag
Change specific properties of a feature flag.
ActionTry it
Move feature to project
Moves the specified feature to the new project in the request schema. Requires you to have permissions to move the feature flag in both projects. Features that are included in any active change requests can not be moved.
ActionTry it
Patch a feature's variants in an environment
Apply a list of patches to the features environments in the specified environment. The patch objects should conform to the [JSON-patch format (RFC 6902)](https://www.rfc-editor.org/rfc/rfc6902).
ActionTry it
Query impact metrics time series data
Queries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.
ActionTry it
Reads the Unleash license
Reads the Unleash license. Only available for self-hosted Enterprise customers.
ActionTry it
Register a new impact metric
Registers a new impact metric by pushing 0-values.
ActionTry it
Reject a user access request
Rejects an existing user access request identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Remove an environment from a project
This endpoint removes the specified environment from the project.
ActionTry it
Remove project access for a group
Removes project access for a group by removing all of its roles for the project.
ActionTry it
Remove project access for a user
Removes project access for a user by removing all of its roles for the project.
ActionTry it
Resume paused milestone progressions
Resumes all paused milestone progressions for a release plan
ActionTry it
Retrieves change request configuration for a project
Given a projectId, this endpoint will retrieve change request configuration for the project
ActionTry it
Retrieves number of project change requests in each state
This endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review
ActionTry it
Retrieves one change request by id
This endpoint will retrieve one change request if it matches the provided id.
ActionTry it
Retrieves pending change requests in configured environments
This endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.
ActionTry it
Returns the list of permissions for the service account
Gets a list of permissions for a service account. Project and environment can be specified.
ActionTry it
Revives a feature
This endpoint revives the specified feature from archive.
ActionTry it
Revives a list of features
This endpoint revives the specified features.
ActionTry it
Save impact metric configuration
Create or update an instance-level or feature-level impact metric chart configuration. Omit id to create one; provide its id to update it.
ActionTry it
Search change requests
Search and filter change requests by creator and approver.
ActionTry it
Search Features
Search and filter feature flags across projects. Returns one offset-paginated page; pass cursor unchanged to continue the same search.
ActionTry it
Search for events
Allows searching for events that match the query parameter criteria.
ActionTry it
Search users
It will preform a simple search based on name and email matching the given query. Requires minimum 2 characters.
ActionTry it
Set a new Unleash license
Set a new Unleash license. Only available for self-hosted Enterprise customers.
ActionTry it
Set Action Set State
Enable or disable one project action set.
ActionTry it
Set Banner State
Enable or disable an instance banner.
ActionTry it
Set change request reviewers
Replace the requested reviewers for a change request with the complete supplied user-ID list. Omitted existing IDs are removed, an empty list removes every reviewer, and at most 10 reviewers are allowed.
ActionTry it
Set Email Subscription
Subscribe or unsubscribe the current principal from an email notification category.
ActionTry it
Set Environment State
Enable or disable an environment across the Unleash instance.
ActionTry it
Set environment-default strategy
Sets a default strategy for this environment. Unleash will use this strategy by default when enabling a feature flag. Use the wild card "*" for `:environment` to add to all environments.
ActionTry it
Set Feature Environment State
Enable or disable one feature flag in one environment.
ActionTry it
Set Feature Favorite
Add or remove one feature flag from the current principal's favorites.
ActionTry it
Set Feature Lifecycle Completion
Mark a feature lifecycle as completed with a kept or discarded outcome, or mark it incomplete again.
ActionTry it
Set Features Environment State
Enable or disable the supplied feature flags in one project environment.
ActionTry it
Set OIDC settings
Configure or partially update OpenID Connect login, user auto-creation, roles, group syncing, PKCE, and scopes. Disabling OIDC or replacing invalid credentials can immediately prevent users from signing in; treat the client secret as sensitive.
ActionTry it
Set Project Archived
Archive or revive one project; archiving requires all project flags to be archived first.
ActionTry it
Set Project Favorite
Add or remove one project from the current principal's favorites.
ActionTry it
Set SCIM settings
Sets new settings for SCIM provisioning. This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Set Signal Endpoint State
Enable or disable one outbound signal endpoint.
ActionTry it
Set Strategy Deprecated
Deprecate or reactivate one custom strategy type.
ActionTry it
Set strategy sort order
Replace the sort order for the complete supplied list of strategy instances in this feature environment.
ActionTry it
Set the external impact-metrics source
Updates the configuration of the external impact-metrics source (any Prometheus-compatible endpoint).
ActionTry it
Set users and groups to roles in the current project
Replaces the complete project access configuration with the supplied role assignments. Existing assignments omitted from roles are removed; an empty roles list removes all project access assignments. Within a role, an empty users or groups list removes every assignment of that type for that role.
ActionTry it
Sets allowed CORS origins
Sets Cross-Origin Resource Sharing headers for Frontend SDK API.
ActionTry it
Sets roles for group
Replace all project roles assigned to a group. Pass the complete desired role ID list; an empty list removes all of the group's roles and its project access.
ActionTry it
Sets roles for user
Replace all project roles assigned directly to a user. Pass the complete desired role ID list; an empty list removes all direct roles and therefore the user's direct project access.
ActionTry it
Start a release plan milestone
Starts a release plan milestone, advancing a one-way release transition that may apply the milestone's rollout configuration and cannot simply be undone.
ActionTry it
This endpoint will add a comment to a change request
This endpoint will add a comment to a change request for the user making the request.
ActionTry it
This endpoint will update the custom title of a change request
Replace a change request's custom title. Pass an empty title to clear it and restore display of Unleash's generated default, such as Change Request #1.
ActionTry it
This endpoint will update the state of a change request
Move a change request to Draft, In review, Approved, Cancelled, or Applied when Unleash's transition rules allow it. Approval requires at least one change and enough approvals. Applied and Cancelled are terminal and cannot be changed afterward; editing an Approved request returns it to In review and clears its approvals.
ActionTry it
Toggle remote MCP server settings
Toggles the remote MCP server for this Unleash instance.
ActionTry it
Update a banner
Updates an existing banner identified by its id.
ActionTry it
Update a feature link
Update an existing feature link.
ActionTry it
Update a group
Update existing user group by group id. It overrides previous group details.
ActionTry it
Update a milestone strategy
Update a milestone strategy configuration for a feature flag in the specified environment.
ActionTry it
Update a release template
Updates a release template's name, description, and replacement milestone configuration. Unleash will delete and rebuild existing milestones from the supplied `milestones` body field, so this cannot simply be undone. Project scope uses a beta API.
ActionTry it
Update a role
Update a custom role by its role ID. The provider requires the role name on every update; supplied permissions replace the role's assigned permission list.
ActionTry it
Update a service account
Updates an existing service account identified by its id.
ActionTry it
Update a strategy type
Update a custom strategy type's optional description and replace its complete parameter definition list. Parameters are always required by Unleash; pass an empty list to remove all parameter definitions.
ActionTry it
Update a tag type
Update the configuration for the specified tag type.
ActionTry it
Update a user
Only the explicitly specified fields get updated.
ActionTry it
Update an addon
Replace an external event integration configuration. Provide the provider, description, enabled state, complete event filter, complete project filter, complete environment filter, and all provider parameters required for that provider. Unleash masks stored webhook URLs and other secrets, so callers must resend the real URL or credential on every update. Changing destination configuration or filters redirects future deliveries; setting enabled to true starts delivery and false stops it. Passing null for description clears it to an empty string; empty project or environment lists select all.
ActionTry it
Update Context Field
Update supplied settings of a root or project context field. The project scope uses Unleash's beta project-context API.
ActionTry it
Update environment sort orders
Updates sort orders for the named environments. Environments not specified are unaffected.
ActionTry it
Update Feature
Update supplied description, type, stale or archive state, or impression-data setting on an existing feature flag. Setting archived to true moves the flag into the archive; omitted fields remain unchanged.
ActionTry it
Update Feature Strategy
Replace supplied configuration fields on one feature strategy instance.
ActionTry it
Update feature tags
Sync one or many feature tags with PUT, add one tag with POST, or remove one tag with DELETE. Sync requires both added_tags and removed_tags, applies additions before removals, and accepts an empty list for either effect.
ActionTry it
Update feature type lifetime
Updates the lifetime configuration for the specified [feature flag type](https://docs.getunleash.io/concepts/feature-flags#feature-flag-types). The expected lifetime is an integer representing the number of days before Unleash marks a feature flag of that type as potentially stale. If set to `null` or `0`, then feature flags of that particular type will never be marked as potentially stale. When a feature flag type's expected lifetime is changed, this will also cause any feature flags of this type to be reevaluated for potential staleness.
ActionTry it
Update project
Update a project's name and optionally its description, access mode, or default stickiness. The complete new name is always required; omitted optional fields remain unchanged.
ActionTry it
Update project enterprise settings
Update project enterprise settings with new values. Any fields not provided are ignored.
ActionTry it
Update SAML auth settings
Configure or partially update SAML login, certificates, user auto-creation, roles, and group syncing. Disabling SAML or replacing invalid identity-provider settings can immediately prevent users from signing in.
ActionTry it
Update Segment
Update a segment by replacing its required name and complete constraint list plus optional metadata.
ActionTry it
Update Simple auth settings
Enable or disable simple authentication (username/password). This operation changes access or identity state and may be destructive or immediately disruptive.
ActionTry it
Update strategy segments
Sets the segments of the strategy specified to be exactly the ones passed in the payload. Any segments that were used by the strategy before will be removed if they are not in the provided list of segments.
ActionTry it
Updates an environment by name
Given an environment by name updates the environment with the given payload. Note that `name`, `enabled` and `protected` cannot be changed by this API
ActionTry it
Updates change request configuration for an environment in the project
This endpoint will change the change request configuration for a given environment, set it to either on/off and optionally configure the number of approvals needed. The minimum number of approvals is 1 and the maximum number is 10. If you provide a number higher than 10 or lower than 1, Unleash will clamp it to the allowed range.
ActionTry it
Upsert Context Field Legal Value
Add a legal value to a root or project context field, or update its description when the value already exists. The project scope uses Unleash's beta project-context API.
ActionTry it
Validate a feature flag name
Validates a feature flag name: checks whether the name is URL-friendly and whether a feature with the given name already exists. Returns 200 if the feature name is compliant and unused.
ActionTry it
Validate a role
Check if the role matches schema and has a unique name.
ActionTry it
Validate a tag type
Validates whether if the body of the request is a valid tag and whether the a tag type with that name already exists or not. If a tag type with the same name exists, this operation will return a 409 status code.
ActionTry it
Validate an external impact-metrics source URL
Tests an external impact-metrics source URL on the fly without persisting it. Returns the list of metric names found at the URL on success, or an `error` string explaining what went wrong. Always responds with 200; failures are reported in the body.
ActionTry it
Validate constraint
Validates a constraint definition. Checks whether the context field exists and whether the applied configuration is valid. Additional properties are not allowed on data objects that you send to this endpoint.
ActionTry it
Validate Context Field Name
Check whether a proposed name can be used for a root or project context field. Invalid names produce an Unleash validation error. The project scope uses Unleash's beta project-context API.
ActionTry it
Validate feature import data
Validates a feature flag data set. Checks whether the data can be imported into the specified project and environment. The returned value is an object that contains errors, warnings, and permissions required to perform the import, as described in the [import documentation](https://docs.getunleash.io/concepts/import-export#import-feature-flags).
ActionTry it
Validate password for a user
Validate the password strength. Minimum 10 characters, uppercase letter, number, special character. Treat token or credential values as secrets and never log them.
ActionTry it
Validate project ID
Validate a project ID against Unleash's rules
ActionTry it
Validates archive features
Preview the consequences of archiving the named feature flags. Returns parent features that would leave unarchived child features orphaned and whether the archive would delete feature dependencies; it does not archive anything.
ActionTry it
Validates if a segment name exists
Checks whether a segment name is already in use.
ActionTry it
Validates if an environment name exists
Checks whether an environment name is already in use.
ActionTry it
Validates the Unleash license
Check the current Enterprise license and return whether it is valid, along with any provider status message and its info, warning, or error severity.
ActionTry it
How the Unleash integration works
The Unleash integration connects your Dench AI CRM directly to Unleash, so agents can read and act on your Unleash data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
297 actions are available for agents to invoke on your behalf. Every call runs through Unleash's own authorization, scoped to the account you connect.
Set up Unleash in Dench
- 1
Sign in to your Dench workspace and open Integrations.
- 2
Find Unleash and click Connect — you'll authorize access through Unleash's own sign-in flow. No API keys or code required.
- 3
Ask an agent to use Unleash in chat, or call it from an automation.
- 4
Manage or disconnect the connection any time from workspace settings.
Frequently asked questions
How does the Unleash integration work with Dench?
The Dench Unleash integration connects your AI CRM to Unleash, so AI agents can work with your Unleash data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
What actions can AI agents perform with Unleash via Dench?
The Unleash integration currently exposes 297 actions, including [BETA] Create a signal endpoint, [BETA] Create a signal endpoint token for a specific signal endpoint, [BETA] Create an action set, [BETA] Delete a signal endpoint, [BETA] Delete a signal endpoint token, and [BETA] Delete an action set. Agents invoke them on your behalf from chat or from automations.
Do I need to write code to connect Unleash to Dench?
No. You connect Unleash from your Dench workspace using Unleash's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Is the Unleash integration secure?
Connections are authorized through Unleash's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Unleash connection from your workspace settings at any time.