Check flag

keystringRequired

key

This endpoint expects an object.

companymap from strings to stringsOptional

usermap from strings to stringsOptional

dataobject

The returned resource

paramsmap from strings to any

Input parameters

1	{
2	"data": {
3	"flag": "flag",
4	"reason": "reason",
5	"value": true,
6	"company_id": "company_id",
7	"error": "error",
8	"feature_allocation": 1,
9	"feature_usage": 1,
10	"feature_usage_event": "feature_usage_event",
11	"feature_usage_period": "feature_usage_period",
12	"feature_usage_reset_at": "2024-01-15T09:30:00Z",
13	"flag_id": "flag_id",
14	"rule_id": "rule_id",
15	"rule_type": "rule_type",
16	"user_id": "user_id"
17	},
18	"params": {
19	"key": "value"
20	}
21	}

1	import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2
3	const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4	await client.features.checkFlag("key", {});