For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
  • Billing Credits
    • GETList credits
    • POSTCreate credit
    • GETGet credit
    • PUTUpdate credit
    • DELDelete credit
    • GETList credit bundles
    • POSTCreate credit bundle
    • GETGet credit bundle
    • PUTUpdate credit bundle
    • DELDelete credit bundle
    • POSTGrant credits to company
    • GETList company credit grants
    • GETList credit grants
    • PUTZero out credit grant
    • GETList plan credit grants
    • POSTCreate plan credit grant
    • DELDelete plan credit grant
    • GETGet credit ledger
  • Account Members
    • GETList account members
    • GETGet account member
LogoLogo
SupportDashboard
Flags

The Flag object

Response
1{
2 "id": "flag_DVkYxxxJTZj",
3 "key": "flag-key",
4 "name": "New Flag",
5 "description": "",
6 "flag_type": "boolean",
7 "default_value": false,
8 "created_at": "2024-01-30T16:19:10.065408Z",
9 "updated_at": "2024-01-30T16:19:10.065408Z",
10 "feature_id": "feat_4W9xxx93pjj",
11 "feature": {},
12 "latest_check": {},
13 "rules": {}
14}
Was this page helpful?
Previous

List flags

Next
Built with

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.

Attributes

id
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.