Flags API reference

Flags API · Scheduled-Changes

get/v1/workspaces/{workspace_id}/scheduled-changes/{scheduled_change_id}Auth

Get a scheduled change

One scheduled change, with what it will write and, once run, the history entry or the error.

Path parameters

scheduled_change_id*string · uuid

Id of the scheduled change.

workspace_id*string · uuid

Id of the workspace.

Response · 200 The scheduled change.

id*string · uuid

Id of the scheduled change.

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"

operation*object

`patch` applies its edits to whatever the value is at `run_at`; `replace` (and an approved change request) applies only if the value is still at `base_version`, else it fails.

Example: "patch"

payload*object

What will be written: the patch fields (`value`, `percentage_attribute`, `clear_rules`) or the whole targeting.

base_version*integer

`replace` only: the `version` the change must still find.

Example: 7

change_request_id*string · uuid

The approved change request this applies.

run_at*string · date-time

When it runs (to within about 30 seconds).

status*object

State.

Example: "pending"

note*string

The note the history entry gets.

Example: "Launch at 09:00"

created_by*object

Who scheduled it.

applied_change_id*string · uuid

The history entry it wrote.

executed_at*string · date-time

When it ran.

last_error*object

Why it failed.

created_at*string · date-time

When it was scheduled.

updated_at*string · date-time

When it last changed state.

Example

Request

GET https://api.flags.productcraft.co/v1/workspaces/{workspace_id}/scheduled-changes/{scheduled_change_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",
  "operation": "patch",
  "payload": {},
  "base_version": 7,
  "change_request_id": "00000000-0000-0000-0000-000000000000",
  "run_at": "2026-01-01T00:00:00.000Z",
  "status": "pending",
  "note": "Launch at 09:00",
  "created_by": {},
  "applied_change_id": "00000000-0000-0000-0000-000000000000",
  "executed_at": "2026-01-01T00:00:00.000Z",
  "last_error": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}