Get Editor Workflow

GET

/api/integrations/editor/workflow

curl --request GET \
  --url https://app.lionrapid.com/api/integrations/editor/workflow

Workflow context for the calling editor session’s project.

locale (optional): the locale being edited. When given, the response describes the EFFECTIVE workflow for that locale’s target — the same target ?? project resolution every row decision (advance boundary, postreview lock) uses — so a per-target workflow override renders truthfully in the sidebar. Omitted → project workflow (legacy callers).

Parameters

Query Parameters

locale

Any of:

string

string

null

null

surface

Any of:

string

string

null

null

Header Parameters

x-api-key

Any of:

string

string

null

null

x-lr-surface

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

EditorWorkflowResponse

Project workflow context for the visual editor sidebar.

Fetched once per editor session, used to render a per-row workflow strip showing ‘you are here’ relative to the row’s current stage.

object

stages

Stages

Ordered stages

Array<object>

WorkflowStageItem

One stage in the project’s workflow.

object

index

required

Index

Zero-based stage order

integer

name

required

Name

Display name (uses name_override if set, else stage_type.name)

string

role

Any of:

string

string

null

null

is_postreview

Is Postreview

True for the Postreview stage — rows at/past it cannot Advance (same boundary the advance endpoint enforces).

boolean

user_assigned_stages

User Assigned Stages

Stage indices the calling user is assigned to via UserTargetLink. Empty for PM/admin (they highlight the row’s current stage instead).

Array<integer>

is_pm_admin

Is Pm Admin

True if caller is PM or admin at project scope

boolean

workflow_mode

Workflow Mode

‘per_row’ or ‘per_file’

string

default: per_row

work_stage_count

Work Stage Count

Number of non-Postreview (work) stages — the advance boundary: a row with stage_index >= this value is in postreview and cannot Advance.

integer

0

Example

{
  "is_pm_admin": false,
  "stages": [
    {
      "index": 0,
      "name": "Translation",
      "role": "translator"
    },
    {
      "index": 1,
      "name": "Proofreading",
      "role": "proofreader"
    },
    {
      "index": 2,
      "name": "Review",
      "role": "reviewer"
    }
  ],
  "user_assigned_stages": [
    0
  ],
  "workflow_mode": "per_row"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}