Feature Flags

Feature flags allow you to control feature availability for organizations in your application. Flags can either be enabled for individual organizations or all organizations in an environment. Read more about how feature flags integrate with AuthKit here.

Example Feature Flag

 const featureFlag = {
  object: 'feature_flag',
  id: 'flag_01EHZNVPK3SFK441A1RGBFSHRT',
  name: 'Advanced Analytics',
  slug: 'advanced-analytics',
  description: 'Enable advanced analytics dashboard feature',
  createdAt: '2025-08-04T19:07:33.155Z',
  updatedAt: '2025-08-04T19:07:33.155Z',
};

`interface FeatureFlag`

Get a feature flag

Get the details of an existing feature flag.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const featureFlag =
  await workos.featureFlags.getFeatureFlag('advanced-analytics');

console.log(featureFlag);

`featureFlags.getFeatureFlag()`

`Parameters`

`Returns`

FeatureFlag

List feature flags

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);

`featureFlags.listFeatureFlags()`

`Parameters` `object`

`Returns` `object`

List feature flags for an organization

Get a list of all enabled feature flags for the provided organization.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const featureFlags = await workos.organizations.listOrganizationFeatureFlags({
  organizationId: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
});

console.log(featureFlags.data);

`organizations.listOrganizationFeatureFlags()`

`Parameters` `object`

`Returns` `object`

List feature flags for a user

Get a list of all enabled feature flags for the provided user. This includes feature flags enabled specifically for the user as well as any organizations that the user is a member of.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const featureFlags = await workos.userManagement.listUserFeatureFlags({
  userId: 'user_01EHZNVPK3SFK441A1RGBFSHRT',
});

console.log(featureFlags.data);

`userManagement.listUserFeatureFlags()`

`Parameters` `object`

`Returns` `object`

Add flag target

Enables a feature flag for a specific target in the current environment. Currently, supported targets include users and organizations.

Request

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.featureFlags.addFlagTarget({
  slug: 'test-flag',
  targetId: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
});

`featureFlags.addFlagTarget()`

`Parameters`

Remove flag target

Removes a target from the feature flag’s target list in the current environment. Currently, supported targets include users and organizations.

Request

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

await workos.featureFlags.removeFlagTarget({
  slug: 'test-flag',
  targetId: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
});

`featureFlags.removeFlagTarget()`

`Parameters`

Enable flag

Enables 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);

`featureFlags.enableFeatureFlag()`

`Parameters`

`Returns`

FeatureFlag

Disable flag

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);

`featureFlags.disableFeatureFlag()`

`Parameters`

`Returns`

FeatureFlag

Feature Flags

interface FeatureFlag

object: "feature_flag"

id: string

name: string

slug: string

description: string | null

createdAt: string

updatedAt: string

Get a feature flag

featureFlags.getFeatureFlag()

Parameters

slug: string

Returns

List feature flags

featureFlags.listFeatureFlags()

Parameters object

limit?: number

before?: string

after?: string

order?: "asc" | "desc"

Returns object

data: FeatureFlag[]

list_metadata: object

List feature flags for an organization

organizations.listOrganizationFeatureFlags()

Parameters object

organizationId: string

limit?: number

before?: string

after?: string

order?: "asc" | "desc"

Returns object

data: FeatureFlag[]

listMetadata: object

List feature flags for a user

userManagement.listUserFeatureFlags()

Parameters object

userId: string

limit?: number

before?: string

after?: string

order?: "asc" | "desc"

Returns object

data: FeatureFlag[]

listMetadata: object

Add flag target

featureFlags.addFlagTarget()

Parameters

options: object

slug: string

target_id: string

Remove flag target

featureFlags.removeFlagTarget()

Parameters

options: object

slug: string

target_id: string

Enable flag

featureFlags.enableFeatureFlag()

Parameters

slug: string

Returns

Disable flag

featureFlags.disableFeatureFlag()

Parameters

slug: string

Returns

`interface FeatureFlag`

`featureFlags.getFeatureFlag()`

`Parameters`

`Returns`

`featureFlags.listFeatureFlags()`

`Parameters` `object`

`Returns` `object`

`organizations.listOrganizationFeatureFlags()`

`Parameters` `object`

`Returns` `object`

`userManagement.listUserFeatureFlags()`

`Parameters` `object`

`Returns` `object`

`featureFlags.addFlagTarget()`

`Parameters`

`featureFlags.removeFlagTarget()`

`Parameters`

`featureFlags.enableFeatureFlag()`

`Parameters`

`Returns`

`featureFlags.disableFeatureFlag()`

`Parameters`

`Returns`