Developers API reference Version 1 · generated from the code openapi.json
Routes

steps

List the steps of a flow

GET /api/v1/flows/{flow_id}/steps

The steps of one version, in order, each with its navigation buttons.

version=draft is reserved to who may edit the flow; it adds faults, what the editor flags on a step. A flow that was never published answers 409 not_published for its published version.

Required scope: read

Path parameters

  • flow_id integer · required

    Id of the flow.

Query parameters

  • version string · optional

    published (default) or draft. The draft is only readable by who may edit the flow.

Response

200 FlowSteps

  • flow Flow

    The flow.

    13 fields
    • id integer

      Id, unique among the objects of its type.

    • type string

      Always flow.

    • name string

      Its name.

    • role string or null

      Role of the account on it: owner, editor or reader; null when it holds none of its own.

    • online_status string

      online: open to its readers. offline: closed. pending_online / pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online.

    • parent_id integer or null

      Id of the binder that holds it; null at the root of a space.

    • organisation_id integer or null

      Id of the organisation whose space it lives in; null in a personal space.

    • owner Owner

      The account that owns it.

      2 fields
      • id integer

        Id of the account.

      • name string

        Its name, or its address when it has none.

    • created_at date-time

      When it was created.

    • updated_at date-time

      When it was last changed.

    • is_published boolean

      Whether a published version exists.

    • published_at date-time or null

      When it was last published; null when it never was.

    • has_unpublished_changes boolean or null

      Whether the draft differs from the published version. null for who may not edit the flow.

  • version string

    The version the steps belong to.

  • steps array of Step

    The steps, in order.

    13 fields
    • id integer

      Id of the step. The draft and the published version of a flow carry different ids.

    • reference string

      Short name of the step, unique in its version: what buttons point at.

    • order integer

      Rank in the flow, from 1.

    • title string

      Title. Empty for a reader when the author hid it.

    • content string

      Text, as HTML. Empty for a reader when the author hid it.

    • image_url string or null

      Where to download the image, with the same credential; null without image, or when the author hid it from readers.

    • image_fit string or null

      contain shows the whole image, cover fills its frame. null: never chosen, shown as contain.

    • updated_at date-time

      When it was last changed.

    • display_title boolean or null

      Whether readers see the title. Only given to who may edit.

    • display_content boolean or null

      Whether readers see the text. Only given to who may edit.

    • display_image boolean or null

      Whether readers see the image. Only given to who may edit.

    • buttons array of Button or null

      Its navigation buttons, in order.

      6 fields
      • id integer

        Id of the button.

      • label string

        What the button says.

      • target_step_id integer or null

        Id of the step it leads to; null when it ends the flow, or when its target was deleted.

      • target_reference string

        Reference of the step it leads to, kept after that step is deleted; empty when it ends the flow.

      • ends_procedure boolean

        Whether it ends the flow.

      • target_missing boolean

        Whether it points at a step that was deleted. A draft cannot be published while one remains.

    • faults array of string or null

      Draft only, what the editor flags: missing_target (a button points at a deleted step; blocks publishing) or unreachable (no button of another step leads here).

Errors

  • 401

    No valid credential.

  • 403

    The credential lacks the required scope, or the account may not do this.

  • 404

    Nothing with that id, or nothing the account may open.

  • 422

    A value is missing or malformed.

  • 429

    Too many requests; Retry-After gives the seconds to wait.

planner_banner_ad_pt