API Reference

Describes the REST API that allows clients to manage and update apps, flags and related entities.

List of applications

get

Retrieve all accessible applications

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Query parameters

orgIdstring · min: 1Optional

Organization identifier

Responses

200

Requested resource retrieved successfully

application/json

Collection of Basic app information

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps

HTTPcURLJavaScriptPython

GET /api/apps HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "org": {
        "id": "text",
        "name": "text"
      },
      "id": "text",
      "name": "text",
      "demo": true,
      "flagKeyFormat": "custom",
      "environments": [
        {
          "id": "text",
          "name": "text",
          "isProduction": true,
          "order": 1
        }
      ]
    }
  ]
}

Get details of an application

get

Retrieve a specific application by its identifier

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Responses

200

Requested resource retrieved successfully

application/json

App information with related collections

idstring · min: 1Required

App identifier

namestringRequired

App name

demobooleanRequired

Whether the app is a demo app

flagKeyFormatstring · enumRequired

The enforced key format when creating flags

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}

HTTPcURLJavaScriptPython

GET /api/apps/{appId} HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "org": {
    "id": "text",
    "name": "text"
  },
  "id": "text",
  "name": "text",
  "demo": true,
  "flagKeyFormat": "custom",
  "environments": [
    {
      "id": "text",
      "name": "text",
      "isProduction": true,
      "order": 1,
      "sdkAccess": {
        "publishableKey": "text",
        "secretKey": "text"
      }
    }
  ],
  "stages": [
    {
      "id": "text",
      "name": "text",
      "color": "text",
      "order": 1
    }
  ],
  "segments": [
    {
      "id": "text",
      "name": "text",
      "type": "all"
    }
  ]
}

List flags for application

get

Retrieve all flags for a specific application

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Responses

200

Requested resource retrieved successfully

application/json

Collection response containing flags

totalCountintegerRequired

Total number of flags in collection

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

sortBystring · enumRequired

Sort by

Possible values:

sortOrderstring · enumRequired

Sort order

Default: ascPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/flags

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "description": "text",
      "stage": {
        "id": "text",
        "name": "text",
        "color": "text",
        "order": 1
      },
      "owner": {
        "id": "text",
        "name": "text",
        "email": "[email protected]",
        "avatarUrl": "https://example.com"
      },
      "archived": true,
      "stale": true,
      "permanent": true,
      "createdAt": "text",
      "lastCheckAt": "text",
      "lastTrackAt": "text"
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1,
  "sortBy": "name",
  "sortOrder": "asc"
}

List environments for application

get

Retrieve all environments for a specific application

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Query parameters

sortOrderstring · enumOptional

Sort order applied to the sorting column

Default: ascPossible values:

sortBystring · enumOptional

The column to sort by

Default: orderPossible values:

Responses

200

Requested resource retrieved successfully

application/json

Collection of Basic environment information

sortOrderstring · enumRequired

Sort order applied to the sorting column

Default: ascPossible values:

sortBystring · enumRequired

The column to sort by

Default: orderPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/environments

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/environments HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "isProduction": true,
      "order": 1
    }
  ],
  "sortOrder": "asc",
  "sortBy": "order"
}

Get environment details

get

Retrieve details for a specific environment

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

envIdstring · min: 1Required

Environment identifier

Responses

200

Requested resource retrieved successfully

application/json

Environment details

idstring · min: 1Required

Environment identifier

namestringRequired

Environment name

isProductionbooleanRequired

Whether the environment is a production environment

orderintegerRequired

Environment order in the app (zero-indexed)

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/environments/{envId}

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/environments/{envId} HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "isProduction": true,
  "order": 1,
  "sdkAccess": {
    "publishableKey": "text",
    "secretKey": "text"
  }
}

Create a flag

post

Create a new flag in the application. Returns the created flag details.

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Body

application/json

keystring · min: 1Required

Key of the flag

namestring · min: 1Required

Name of the flag

descriptionany ofOptional

Description of the flag

string · max: 8192Optional

or

nullOptional

stageIdstring · min: 14 · max: 14Optional

Stage ID of the flag

ownerUserIdany ofOptional

stringOptional

or

nullOptional

permanentbooleanOptionalDefault: false

secretbooleanOptional

Whether the flag is secret

Responses

200

Requested resource retrieved successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

post

/apps/{appId}/flags

HTTPcURLJavaScriptPython

POST /api/apps/{appId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "key": "text",
  "name": "text",
  "description": "text",
  "stageId": "text",
  "ownerUserId": "text",
  "permanent": false,
  "secret": true
}

{
  "flag": {
    "id": "text",
    "key": "text",
    "name": "text",
    "description": "text",
    "stage": {
      "id": "text",
      "name": "text",
      "color": "text",
      "order": 1
    },
    "owner": {
      "id": "text",
      "name": "text",
      "email": "[email protected]",
      "avatarUrl": "https://example.com"
    },
    "archived": true,
    "stale": true,
    "permanent": true,
    "createdAt": "text",
    "lastCheckAt": "text",
    "lastTrackAt": "text",
    "rolledOutToEveryoneAt": "text",
    "parentFlagId": "text"
  }
}

Update a flag

patch

Update an existing flag

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

flagIdstring · min: 1Required

Flag ID

Body

application/json

namestring · min: 1Optional

Name of the flag

descriptionany ofOptional

Description of the flag

string · max: 8192Optional

or

nullOptional

ownerUserIdany ofOptional

stringOptional

or

nullOptional

permanentbooleanOptional

secretbooleanOptional

Whether the flag is secret

isArchivedbooleanOptional

stageIdstring · min: 14 · max: 14Optional

Stage ID of the flag

Responses

200

Requested resource retrieved successfully

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

patch

/apps/{appId}/flags/{flagId}

HTTPcURLJavaScriptPython

PATCH /api/apps/{appId}/flags/{flagId} HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "name": "text",
  "description": "text",
  "ownerUserId": "text",
  "permanent": true,
  "secret": true,
  "isArchived": true,
  "stageId": "text"
}

{
  "flag": {
    "id": "text",
    "key": "text",
    "name": "text",
    "description": "text",
    "stage": {
      "id": "text",
      "name": "text",
      "color": "text",
      "order": 1
    },
    "owner": {
      "id": "text",
      "name": "text",
      "email": "[email protected]",
      "avatarUrl": "https://example.com"
    },
    "archived": true,
    "stale": true,
    "permanent": true,
    "createdAt": "text",
    "lastCheckAt": "text",
    "lastTrackAt": "text",
    "rolledOutToEveryoneAt": "text",
    "parentFlagId": "text"
  }
}

Get flags for a company

get

Retrieve all flags with their targeting status for a specific company

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

envIdstring · min: 1Required

Environment identifier

companyIdstring · min: 1Required

Company ID within your application

Responses

200

Requested resource retrieved successfully

application/json

Response containing flags for an entity

totalCountintegerRequired

Total number of flags

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/envs/{envId}/companies/{companyId}/flags

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/envs/{envId}/companies/{companyId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "createdAt": "text",
      "value": true,
      "specificTargetValue": true,
      "firstExposureAt": "text",
      "lastExposureAt": "text",
      "lastCheckAt": "text",
      "exposureCount": 1,
      "firstTrackAt": "text",
      "lastTrackAt": "text",
      "trackCount": 1
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1
}

Update flag targeting for a company

patch

Update specific targeting for flags for a company in an environment

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

envIdstring · min: 1Required

Environment identifier

companyIdstring · min: 1Required

Company ID within your application

Body

application/json

Request body for updating flags for an entity

changeDescriptionstringOptional

Description of the change for audit history

notificationsbooleanOptional

Whether to send notifications about the change (default: true)

Default: true

Responses

200

Requested resource retrieved successfully

application/json

Response containing flags for an entity

totalCountintegerRequired

Total number of flags

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

patch

/apps/{appId}/envs/{envId}/companies/{companyId}/flags

HTTPcURLJavaScriptPython

PATCH /api/apps/{appId}/envs/{envId}/companies/{companyId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "updates": [
    {
      "flagKey": "text",
      "specificTargetValue": true
    }
  ],
  "changeDescription": "text",
  "notifications": true
}

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "createdAt": "text",
      "value": true,
      "specificTargetValue": true,
      "firstExposureAt": "text",
      "lastExposureAt": "text",
      "lastCheckAt": "text",
      "exposureCount": 1,
      "firstTrackAt": "text",
      "lastTrackAt": "text",
      "trackCount": 1
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1
}

Get flags for a user

get

Retrieve all flags with their targeting status for a specific user

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

envIdstring · min: 1Required

Environment identifier

userIdstring · min: 1Required

User ID within your application

Responses

200

Requested resource retrieved successfully

application/json

Response containing flags for an entity

totalCountintegerRequired

Total number of flags

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/envs/{envId}/users/{userId}/flags

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/envs/{envId}/users/{userId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "createdAt": "text",
      "value": true,
      "specificTargetValue": true,
      "firstExposureAt": "text",
      "lastExposureAt": "text",
      "lastCheckAt": "text",
      "exposureCount": 1,
      "firstTrackAt": "text",
      "lastTrackAt": "text",
      "trackCount": 1
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1
}

Update flag targeting for a user

patch

Update specific targeting for flags for a user in an environment

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

envIdstring · min: 1Required

Environment identifier

userIdstring · min: 1Required

User ID within your application

Body

application/json

Request body for updating flags for an entity

changeDescriptionstringOptional

Description of the change for audit history

notificationsbooleanOptional

Whether to send notifications about the change (default: true)

Default: true

Responses

200

Requested resource retrieved successfully

application/json

Response containing flags for an entity

totalCountintegerRequired

Total number of flags

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

patch

/apps/{appId}/envs/{envId}/users/{userId}/flags

HTTPcURLJavaScriptPython

PATCH /api/apps/{appId}/envs/{envId}/users/{userId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "updates": [
    {
      "flagKey": "text",
      "specificTargetValue": true
    }
  ],
  "changeDescription": "text",
  "notifications": true
}

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "createdAt": "text",
      "value": true,
      "specificTargetValue": true,
      "firstExposureAt": "text",
      "lastExposureAt": "text",
      "lastCheckAt": "text",
      "exposureCount": 1,
      "firstTrackAt": "text",
      "lastTrackAt": "text",
      "trackCount": 1
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1
}

Get flag targeting for an environment

get

Retrieve targeting for a flag in an environment

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

flagKeystring · min: 1Required

Unique flag key

envIdstring · min: 1Required

Environment identifier

Responses

200

Requested resource retrieved successfully

application/json

Flag targeting information and its audience

flagKeystring · min: 1Required

Unique flag key

versionintegerRequired

Flag targeting version

updatedAtstring · date-timeRequired

Last time the targeting was updated

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/flags/{flagKey}/targeting/{envId}

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/flags/{flagKey}/targeting/{envId} HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "flagKey": "text",
  "version": 1,
  "updatedAt": "2026-03-06T18:42:00.512Z",
  "specificTargets": {
    "ANY_ADDITIONAL_PROPERTY": {
      "companyIds": [
        "text"
      ],
      "userIds": [
        "text"
      ]
    }
  }
}

Get details of an application

get

Retrieve a specific application by its identifier

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Responses

200

Requested resource retrieved successfully

application/json

App information with related collections

idstring · min: 1Required

App identifier

namestringRequired

App name

demobooleanRequired

Whether the app is a demo app

flagKeyFormatstring · enumRequired

The enforced key format when creating flags

Possible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}

HTTPcURLJavaScriptPython

GET /api/apps/{appId} HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "org": {
    "id": "text",
    "name": "text"
  },
  "id": "text",
  "name": "text",
  "demo": true,
  "flagKeyFormat": "custom",
  "environments": [
    {
      "id": "text",
      "name": "text",
      "isProduction": true,
      "order": 1,
      "sdkAccess": {
        "publishableKey": "text",
        "secretKey": "text"
      }
    }
  ],
  "stages": [
    {
      "id": "text",
      "name": "text",
      "color": "text",
      "order": 1
    }
  ],
  "segments": [
    {
      "id": "text",
      "name": "text",
      "type": "all"
    }
  ]
}

List of applications

get

Retrieve all accessible applications

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Query parameters

orgIdstring · min: 1Optional

Organization identifier

Responses

200

Requested resource retrieved successfully

application/json

Collection of Basic app information

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps

HTTPcURLJavaScriptPython

GET /api/apps HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "org": {
        "id": "text",
        "name": "text"
      },
      "id": "text",
      "name": "text",
      "demo": true,
      "flagKeyFormat": "custom",
      "environments": [
        {
          "id": "text",
          "name": "text",
          "isProduction": true,
          "order": 1
        }
      ]
    }
  ]
}

List flags for application

get

Retrieve all flags for a specific application

Authorizations

APIKey

AuthorizationstringRequired

API key authentication, for service access

Path parameters

appIdstring · min: 1Required

App identifier

Responses

200

Requested resource retrieved successfully

application/json

Collection response containing flags

totalCountintegerRequired

Total number of flags in collection

pageSizeintegerRequired

Page size

pageIndexintegerRequired

Page index

sortBystring · enumRequired

Sort by

Possible values:

sortOrderstring · enumRequired

Sort order

Default: ascPossible values:

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Requested resource, or its parent, not found

application/json

get

/apps/{appId}/flags

HTTPcURLJavaScriptPython

GET /api/apps/{appId}/flags HTTP/1.1
Host: app.reflag.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "name": "text",
      "description": "text",
      "stage": {
        "id": "text",
        "name": "text",
        "color": "text",
        "order": 1
      },
      "owner": {
        "id": "text",
        "name": "text",
        "email": "[email protected]",
        "avatarUrl": "https://example.com"
      },
      "archived": true,
      "stale": true,
      "permanent": true,
      "createdAt": "text",
      "lastCheckAt": "text",
      "lastTrackAt": "text"
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "pageIndex": 1,
  "sortBy": "name",
  "sortOrder": "asc"
}