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

200

OK

application/json

Schema

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:
Property	Description
current	Always the current page
first	Always the first page
last	null if there is only one page.
prev	null if you are on the first page.
next	null 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.
]

Example (from schema)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "flow",
      "name": "Products",
      "slug": "products",
      "description": "Extends the default product object",
      "enabled": true,
      "links": {
        "self": "https://euwest.api.elasticpath.com/v2/flows/d2a9b22a-b4b0-456b-bbc7-d8723aaffa84"
      },
      "relationships": {
        "fields": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "brand"
          }
        }
      },
      "meta": {
        "owner": "enum",
        "timestamps": {
          "created_at": "2023-10-11T13:02:25.293Z",
          "updated_at": "2023-10-11T13:02:25.293Z"
        }
      }
    }
  ]
}

default

{
  "data": [
    {
      "id": "6d320b42-237d-4474-8452-d49f884d4ae1",
      "type": "flow",
      "name": "Products-1",
      "slug": "products-1",
      "description": "Extends the default product object",
      "enabled": true,
      "links": {
        "self": "https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1"
      },
      "relationships": {},
      "meta": {
        "owner": "organization",
        "timestamps": {
          "created_at": "2018-05-10T18:04:26.623Z",
          "updated_at": "2018-05-10T18:04:26.623Z"
        }
      }
    }
  ]
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": 400,
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...