Flags API reference

Flags API · Ramps

get/v1/workspaces/{workspace_id}/rampsAuth

List ramps

Percentage ramps, newest first. Filter by `status` (`active`, `paused`, `completed`, `cancelled`, `failed`), project, environment or setting.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Query parameters

statusstring

Only this status.

project_idstring · uuid

Only this project.

environment_idstring · uuid

Only this environment.

setting_idstring · uuid

Only this setting.

cursorstring

Opaque cursor from `pagination.next_cursor`.

limitinteger

Page size.

Response · 200 A page of ramps.

data*array

Ramps, newest first.

pagination*object

Cursor pagination.

Example

Request

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

Response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {}
}