Flags API reference

Flags API · Ramps

get/v1/workspaces/{workspace_id}/ramps/{ramp_id}Auth

Get a ramp

One ramp with its steps, the percentage it reached and its state.

Path parameters

ramp_id*string · uuid

Id of the ramp.

workspace_id*string · uuid

Id of the workspace.

Response · 200 The ramp.

id*string · uuid

Id of the ramp.

workspace_id*string · uuid

The workspace.

project_id*string · uuid

The project.

config_id*string · uuid

The config.

setting_id*string · uuid

The setting.

setting_key*string

The setting's key.

Example: "new_checkout"

environment_id*string · uuid

The environment.

environment_key*string

The environment's key.

Example: "production"

value*object

The value served to the ramped percentage; everyone else keeps the default value.

Example: true

steps*array

The steps and which have been applied.

current_percentage*integer

Percentage served now (0 before the first step).

Example: 25

status*object

State.

Example: "active"

note*string

Note on every step in the history.

Example: "Ramp the new checkout"

change_request_id*string · uuid

The approved change request that started it.

created_by*object

Who started it.

last_change_id*string · uuid

The history entry of the last step.

last_error*object

Why it failed.

created_at*string · date-time

When it was created.

updated_at*string · date-time

When it last changed.

Example

Request

GET https://api.flags.productcraft.co/v1/workspaces/{workspace_id}/ramps/{ramp_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "config_id": "00000000-0000-0000-0000-000000000000",
  "setting_id": "00000000-0000-0000-0000-000000000000",
  "setting_key": "new_checkout",
  "environment_id": "00000000-0000-0000-0000-000000000000",
  "environment_key": "production",
  "value": true,
  "steps": [
    {
      "percentage": 25,
      "at": "2026-01-01T00:00:00.000Z",
      "applied": false
    }
  ],
  "current_percentage": 25,
  "status": "active",
  "note": "Ramp the new checkout",
  "change_request_id": "00000000-0000-0000-0000-000000000000",
  "created_by": {},
  "last_change_id": "00000000-0000-0000-0000-000000000000",
  "last_error": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}