Skip to main content

Get all Flows

GET 

/v2/flows

  • For Commerce, this endpoint retrieves a list of flows.
  • For Product Experience Manager, this endpoint retrieves a list of templates.

Responses

OK

Schema
    data object[]
  • Array [
  • id uuid

    A unique identifier for a resource.

    type string

    A unique identifier for a flow/template.

    name string

    The name of a flow/template.

    slug string

    A unique identifier of a flow/template.

    description string

    A short description for a flow/template.

    enabled boolean
    links object

    Links allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Listing pages use the following:

    PropertyDescription
    currentAlways the current page
    firstAlways the first page
    lastnull if there is only one page.
    prevnull if you are on the first page.
    nextnull if there is only one page.
    self string
    relationships object

    Relationships are established between different flows/templates entities. For example, a field and an entry are related to a flow as both are attached to it.

    fields object
    data object
    id uuid

    A unique identifier for a resource.

    type string

    Represents the type of object being returned.

    meta object
    owner string

    Possible values: [store, organization]

    The resource owner, either organization or store.

    timestamps object
    created_at string

    The date and time a resource is created.

    updated_at string

    The date and time a resource is updated.

  • ]
Loading...