The Flag object — SchematicHQ

The Flag object describes flags within your application. A new Flag is created in the Schematic application or via the API.

A Flag can target Users and Companies via rules. Rules can be based on objects, traits, or events.

string

Unique id generated by Schematic for the object.

key

string

The flag’s unique key, which can be used to reference the flag.

name

string

The flag’s name, which is displayable to Schematic users.

description

string

The flag’s description, which is displayable to Schematic users.

flag_type

string

The flag’s type, which is currently limited to boolean.

default_value

boolean

The flag’s default value, which is served if no rules match.

created_at

datetime

Datetime when the flag was created. Format is ISO 8601.

updated_at

datetime

Datetime when the flag was updated. Format is ISO 8601.

feature_id

string

Unique id of the feature the flag is associated with, if any.

feature

dictionary

Set of features that the flag is associated with. Flags may only be associated with one feature.

latest_check

dictionary

Result of the latest flag evaluation.

rules

dictionary

Set of rules associated with the flag.