Flags API reference

Flags API · Settings

get/v1/workspaces/{workspace_id}/configs/{config_id}/compareAuth

Compare environments

Each setting's value and targeting side by side in 2-5 environments, with `differs` per setting.

Path parameters

config_id*string · uuid

Id of the config.

workspace_id*string · uuid

Id of the workspace.

Query parameters

cursorstring

Opaque cursor for pagination: the `next_cursor` of the previous page.

limitinteger

Page size.

environment_ids*string

Comma-separated environment ids of the config's project, 2-5 of them.

Response · 200 A page of settings compared.

environments*array

The compared environments, in request order.

data*array

One row per setting, in `ordinal` order.

pagination*object

The cursor for the next page.

Example

Request

GET https://api.flags.productcraft.co/v1/workspaces/{workspace_id}/configs/{config_id}/compare
Authorization: Bearer YOUR_TOKEN

Response

{
  "environments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "key": "production",
      "name": "Production"
    }
  ],
  "data": [
    {
      "setting": {},
      "values": [
        {
          "setting_id": "00000000-0000-0000-0000-000000000000",
          "environment_id": "00000000-0000-0000-0000-000000000000",
          "environment_key": "production",
          "value": false,
          "rules": [
            null
          ],
          "percentages": [
            null
          ],
          "percentage_attribute": null,
          "version": 3,
          "updated_by": {},
          "updated_at": "2026-01-01T00:00:00.000Z"
        }
      ],
      "differs": true
    }
  ],
  "pagination": {}
}