API Reference

Features enabled

get

/features/enabled

Use this endpoint to get the list of enabled features for the user. The response will contain the list of features that are enabled for the user.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Query parameters

keystring · min: 1 · max: 255Optional

Feature key - unique identifier of the feature which you can find in app.reflag.com Example:

new-order-created

Responses

200

application/json

400

Bad request

application/json

get

/features/enabled

function flattenObject(obj, prefix = '') {
  return Object.keys(obj).reduce((acc, key) => {
    const value = obj[key];
    const newKey = prefix ? `${prefix}.${encodeURIComponent(key)}` : encodeURIComponent(key);

    if (typeof value === 'object' && value !== null) {
      Object.assign(acc, flattenObject(value, newKey));
    } else {
      acc[newKey] = encodeURIComponent(value);
    }

    return acc;
  }, {});
}

function encodeQueryParams(deepObject) {
  const flattened = flattenObject(deepObject);
  return Object.keys(flattened)
    .map(key => `${key}=${flattened[key]}`)
    .join('&');
}

const params = {
  context: {
    user: {
      id: 'u2956',
      role: 'developer',
    },
    company: {
      id: 'c123',
      name: 'Example Inc',
      country: 'US',
    },
  },
};

// Perform the GET request using fetch
const res = await fetch(`https://front.reflag.com/features/enabled?${encodeQueryParams(params)}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer <your_public_key>`,
  },
});
const data = await res.json();
console.log(data);

{
  "success": true,
  "features": {
    "ANY_ADDITIONAL_PROPERTY": {
      "key": "text",
      "targetingVersion": 1,
      "isEnabled": true,
      "stage": null,
      "config": {
        "name": null,
        "version": 1,
        "default": true,
        "payload": null,
        "ruleEvaluationResults": [
          true
        ],
        "missingContextFields": [
          "text"
        ]
      },
      "ruleEvaluationResults": [
        true
      ],
      "missingContextFields": [
        "text"
      ]
    }
  },
  "remoteContextUsed": true
}

Features

get

/features

Use this endpoint to get the list of all features with their targeting rules.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

Authorization: Bearer <secret_key>

Responses

200

application/json

400

Bad request

application/json

get

/features

GET /features HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "features": [
    {
      "key": "text",
      "description": null,
      "createdAt": "text",
      "link": null,
      "targeting": {
        "version": 1,
        "rules": [
          "[Circular Reference]"
        ]
      },
      "config": {
        "version": 1,
        "variants": [
          "[Circular Reference]"
        ]
      },
      "stage": null
    }
  ]
}

Features evaluated

get

/features/evaluated

Use this endpoint to get the list of all features evaluated for the user.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Query parameters

keystring · min: 1 · max: 255Optional

Feature key - unique identifier of the feature which you can find in app.reflag.com Example:

new-order-created

Responses

200

application/json

400

Bad request

application/json

get

/features/evaluated

function flattenObject(obj, prefix = '') {
  return Object.keys(obj).reduce((acc, key) => {
    const value = obj[key];
    const newKey = prefix ? `${prefix}.${encodeURIComponent(key)}` : encodeURIComponent(key);

    if (typeof value === 'object' && value !== null) {
      Object.assign(acc, flattenObject(value, newKey));
    } else {
      acc[newKey] = encodeURIComponent(value);
    }

    return acc;
  }, {});
}

function encodeQueryParams(deepObject) {
  const flattened = flattenObject(deepObject);
  return Object.keys(flattened)
    .map(key => `${key}=${flattened[key]}`)
    .join('&');
}

const params = {
  context: {
    user: {
      id: 'u2956',
      role: 'developer',
    },
    company: {
      id: 'c123',
      name: 'Example Inc',
      country: 'US',
    },
  },
};

// Perform the GET request using fetch
const res = await fetch(`https://front.reflag.com/features/evaluated?${encodeQueryParams(params)}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your_public_key>',
  },
});
const data = await res.json();
console.log(data);

{
  "success": true,
  "features": {
    "ANY_ADDITIONAL_PROPERTY": {
      "key": "text",
      "targetingVersion": 1,
      "isEnabled": true,
      "stage": null,
      "config": {
        "name": null,
        "version": 1,
        "default": true,
        "payload": null,
        "ruleEvaluationResults": [
          true
        ],
        "missingContextFields": [
          "text"
        ]
      },
      "ruleEvaluationResults": [
        true
      ],
      "missingContextFields": [
        "text"
      ]
    }
  },
  "remoteContextUsed": true
}

Features events

post

/features/events

Use this endpoint to send feature events to Reflag.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Bodyobject · FeatureEvent[]

Represents an event related to feature flag evaluation

actionstring · enumRequiredPossible values:

keystring · min: 1 · max: 255Required

Feature key - unique identifier of the feature which you can find in app.reflag.com Example:

new-order-created

targetingVersionnumberOptional

The version of the targeting rules. Every time when targeting rules are updated the version is incremented.

evalResultbooleanRequired

The result of the evaluation

evalRuleResultsboolean[]Optional

The results of evaluation for each of the rules

evalMissingFieldsstring[]Optional

The fields that were missing in the context for successful evaluation

Responses

200

application/json

400

Bad request

application/json

post

/features/events

POST /features/events HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 176

[
  {
    "action": "check-is-enabled",
    "key": "text",
    "targetingVersion": 1,
    "evalContext": {
      "user": {},
      "company": {}
    },
    "evalResult": true,
    "evalRuleResults": [
      true
    ],
    "evalMissingFields": [
      "text"
    ]
  }
]

{
  "success": true
}

User

post

/user

Use this endpoint when you want to send user attributes to Reflag. If the user does not exist, it will be created. This endpoint is also used whenever you construct Reflag client in any of the SDKs.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Body

Represents a user entity with their attributes and metadata

userIdstring · min: 1Required

Unique identifier for the user

attributesobject · attributesOptional

Additional attributes of the user

timestampstring · date-timeOptional

Timestamp associated with the user data

Responses

200

application/json

400

Bad request

application/json

post

/user

POST /user HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "userId": "text",
  "attributes": {},
  "timestamp": "2026-02-07T01:59:32.640Z"
}

{
  "success": true
}

Company

post

/company

Use this endpoint when you want to send company attributes to Reflag. If the company does not exist, it will be created. You can also use this endpoint to assign user to a company by including the user ID. This endpoint is also used whenever you construct Reflag client in any of the SDKs.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Body

Represents a company entity with its attributes and associated user

userIdstring · min: 1Optional

Identifier for the user linked to the company

companyIdstring · min: 1Required

Unique identifier for the company

attributesobject · attributesOptional

Additional attributes of the company

timestampstring · date-timeOptional

Timestamp associated with the company data

Responses

200

application/json

400

Bad request

application/json

post

/company

POST /company HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "userId": "text",
  "companyId": "text",
  "attributes": {},
  "timestamp": "2026-02-07T01:59:32.640Z"
}

{
  "success": true
}

Event

post

/event

Use this endpoint when you want to send a tracking events to Reflag.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Body

Represents a tracking event with associated user, company, and metadata

userIdstring · min: 1Required

Identifier for the user initiating the event

eventstring · min: 1Required

The name of the generated event

attributesobject · attributesOptional

Additional event-related attributes

companyIdstring · min: 1Optional

Identifier for the company linked to the event

timestampstring · date-timeOptional

Timestamp associated with the event

Responses

200

application/json

400

Bad request

application/json

post

/event

POST /event HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "userId": "text",
  "event": "text",
  "attributes": {},
  "companyId": "text",
  "timestamp": "2026-02-07T01:59:32.640Z"
}

{
  "success": true
}

Feedback

post

/feedback

Use this endpoint when you want to send feedback events to Reflag.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Body

Represents user feedback data with associated context and metadata

feedbackIdstring · min: 1Optional

Unique identifier for updating existing feedback

userIdstring · min: 1Required

Identifier of the user providing feedback

companyIdstring · min: 1Optional

Identifier of the company linked to the feedback

promptIdstring · min: 10 · max: 40Optional

Identifier of the feedback prompt

featureIdstring · min: 1 · max: 14Optional

Identifier of the feature the feedback is related to

keystring · min: 1 · max: 255Optional

Feature key - unique identifier of the feature which you can find in app.reflag.com Example:

new-order-created

questionstring · min: 1 · max: 256Optional

In case the feedback is initiated by a prompt this will be the question which was asked

promptedQuestionstring · min: 1 · max: 256Optional

In case the feedback is initiated by a prompt this will be the question which was asked

sourcestring · enumOptional

The source of the feedback

Possible values:

scorenumber · max: 5Optional

The score of the feedback

commentstring · min: 1 · max: 4000Optional

The user's input

timestampstring · date-timeOptional

When the feedback was submitted

Responses

200

application/json

400

Bad request

application/json

post

/feedback

POST /feedback HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "feedbackId": "text",
  "userId": "text",
  "companyId": "text",
  "promptId": "text",
  "featureId": "text",
  "key": "text",
  "question": "text",
  "promptedQuestion": "text",
  "source": "api",
  "score": 1,
  "comment": "text",
  "timestamp": "2026-02-07T01:59:32.640Z"
}

{
  "success": true
}

Bulk

post

/bulk

Use this endpoint when you want to send multiple events to Reflag.

Authorizations

AuthorizationstringRequired

Set the Authorization header to:

  Authorization: Bearer <publishable_key>

Bodyall of[]

A collection of different types of operations to be processed in bulk

and

anyOptional

Responses

200

application/json

400

Bad request

application/json

post

/bulk

POST /bulk HTTP/1.1
Host: front.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

[
  {
    "type": "user",
    "userId": "text",
    "attributes": {},
    "timestamp": "2026-02-07T01:59:32.640Z"
  }
]

{
  "success": true
}

Rules schema

Attribute

Type

Description

filter

Filter

Object containing filtering rules which will evaluate against context object. Filter can be an instance of 5 different filter types described below.

Filter Schema

Attribute

Type

Desription

type

group

Filter group will evaluate by applying a logical operation to the array of filters provided

filters

Filter[]

Array of filters

operator

enum(and, or)

Logical operation

PreviousPublic API NextReflag REST API

Last updated 4 months ago

Was this helpful?

hashtagFeatures enabled

hashtagFeatures

hashtagFeatures evaluated

hashtagFeatures events

hashtagUser

hashtagCompany

hashtagEvent

hashtagFeedback

hashtagBulk

hashtagRules schema

hashtagFilter Schema

Features enabled

Features

Features evaluated

Features events

User

Company

Event

Feedback

Bulk

Rules schema

Filter Schema