A Feature Flag controls feature availability for organizations and users in your application.
Get the details of an existing feature flag by its slug.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); const featureFlag = await workos.featureFlags.getFeatureFlag('advanced-analytics'); console.log(featureFlag);
{ "object": "feature_flag", "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", "slug": "advanced-analytics", "name": "Advanced Analytics", "description": "Enable advanced analytics dashboard feature", "owner": { "email": "jane@example.com", "first_name": "Jane", "last_name": "Doe" }, "tags": [ "reports" ], "enabled": true, "default_value": false, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl "https://api.workos.com/feature-flags/advanced-analytics" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const featureFlag = | |
| await workos.featureFlags.getFeatureFlag('advanced-analytics'); | |
| console.log(featureFlag); |
| { | |
| "object": "feature_flag", | |
| "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "slug": "advanced-analytics", | |
| "name": "Advanced Analytics", | |
| "description": "Enable advanced analytics dashboard feature", | |
| "owner": { | |
| "email": "jane@example.com", | |
| "first_name": "Jane", | |
| "last_name": "Doe" | |
| }, | |
| "tags": [ | |
| "reports" | |
| ], | |
| "enabled": true, | |
| "default_value": false, | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
GET/feature-flagsParameters Returns Get a list of all of your existing feature flags matching the criteria specified.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); const featureFlags = await workos.featureFlags.listFeatureFlags(); console.log(featureFlags.data);
{ "object": "list", "data": [ { "object": "feature_flag", "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", "slug": "advanced-analytics", "name": "Advanced Analytics", "description": "Enable advanced analytics dashboard feature", "owner": { "email": "jane@example.com", "first_name": "Jane", "last_name": "Doe" }, "tags": [ "reports" ], "enabled": true, "default_value": false, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" } ], "list_metadata": { "before": "flag_01HXYZ123456789ABCDEFGHIJ", "after": "flag_01HXYZ987654321KJIHGFEDCBA" } }
| curl "https://api.workos.com/feature-flags" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const featureFlags = await workos.featureFlags.listFeatureFlags(); | |
| console.log(featureFlags.data); |
| { | |
| "object": "list", | |
| "data": [ | |
| { | |
| "object": "feature_flag", | |
| "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "slug": "advanced-analytics", | |
| "name": "Advanced Analytics", | |
| "description": "Enable advanced analytics dashboard feature", | |
| "owner": { | |
| "email": "jane@example.com", | |
| "first_name": "Jane", | |
| "last_name": "Doe" | |
| }, | |
| "tags": [ | |
| "reports" | |
| ], | |
| "enabled": true, | |
| "default_value": false, | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } | |
| ], | |
| "list_metadata": { | |
| "before": "flag_01HXYZ123456789ABCDEFGHIJ", | |
| "after": "flag_01HXYZ987654321KJIHGFEDCBA" | |
| } | |
| } |
GET/feature-flagsParameters Returns objectEnables a feature flag in the current environment.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); const featureFlag = await workos.featureFlags.enableFeatureFlag('advanced-analytics'); console.log(featureFlag);
{ "object": "feature_flag", "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", "slug": "advanced-analytics", "name": "Advanced Analytics", "description": "Enable advanced analytics dashboard feature", "owner": { "email": "jane@example.com", "first_name": "Jane", "last_name": "Doe" }, "tags": [ "reports" ], "enabled": true, "default_value": false, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl --request PUT \ | |
| --url "https://api.workos.com/feature-flags/advanced-analytics/enable" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const featureFlag = | |
| await workos.featureFlags.enableFeatureFlag('advanced-analytics'); | |
| console.log(featureFlag); |
| { | |
| "object": "feature_flag", | |
| "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "slug": "advanced-analytics", | |
| "name": "Advanced Analytics", | |
| "description": "Enable advanced analytics dashboard feature", | |
| "owner": { | |
| "email": "jane@example.com", | |
| "first_name": "Jane", | |
| "last_name": "Doe" | |
| }, | |
| "tags": [ | |
| "reports" | |
| ], | |
| "enabled": true, | |
| "default_value": false, | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
PUT/feature-flagsParameters Returns Disables a feature flag in the current environment.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); const featureFlag = await workos.featureFlags.disableFeatureFlag('advanced-analytics'); console.log(featureFlag);
{ "object": "feature_flag", "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", "slug": "advanced-analytics", "name": "Advanced Analytics", "description": "Enable advanced analytics dashboard feature", "owner": { "email": "jane@example.com", "first_name": "Jane", "last_name": "Doe" }, "tags": [ "reports" ], "enabled": false, "default_value": false, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z" }
| curl --request PUT \ | |
| --url "https://api.workos.com/feature-flags/advanced-analytics/disable" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| const featureFlag = | |
| await workos.featureFlags.disableFeatureFlag('advanced-analytics'); | |
| console.log(featureFlag); |
| { | |
| "object": "feature_flag", | |
| "id": "flag_01EHZNVPK3SFK441A1RGBFSHRT", | |
| "slug": "advanced-analytics", | |
| "name": "Advanced Analytics", | |
| "description": "Enable advanced analytics dashboard feature", | |
| "owner": { | |
| "email": "jane@example.com", | |
| "first_name": "Jane", | |
| "last_name": "Doe" | |
| }, | |
| "tags": [ | |
| "reports" | |
| ], | |
| "enabled": false, | |
| "default_value": false, | |
| "created_at": "2026-01-15T12:00:00.000Z", | |
| "updated_at": "2026-01-15T12:00:00.000Z" | |
| } |
PUT/feature-flagsParameters Returns