Skip to main content
GET
/
flow
/
definition
Retrieve the flow definition list
curl --request GET \
  --url https://api.indieflow.app/v1/flow/definition \
  --header 'X-Api-Key: <api-key>'
{
  "status": "success",
  "exit_code": "success",
  "data": {
    "record_count": 123,
    "records": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "created_at": 123,
        "updated_at": 123,
        "status": "active"
      }
    ]
  }
}

Authorizations

​
X-Api-Key
string
header
required

The api key given to you when you register, no needed when using through RapidAPI

Query Parameters

​
limit
integer
default:20

Page size

Required range: 1 <= x <= 100
​
offset
integer
default:0

Page starting record

Required range: 0 <= x <= 100

Response

Returns the list of flows

A simple response representation The record set of registered flows

​
status
enum<string>

The response status returned from the server, it can be:

  • success: The request worked as expected
  • error: The request returned an error
Available options:
success,
error
​
exit_code
enum<string>

The response exit code returned from the server, it can be:

  • success: The request worked as expected
  • validation_error: The request contains an user input related error
  • unauthorized: Invalid credentials
  • generic_error: The request contains a generic error
  • service_down: The backend server is down
  • flow_disabled: The requested flow is currently marked as disabled
  • service_plan_max_registered_flows_reached: The maximum number of registered flows has been reached, this error also applies when trying to submit a flow after downgrading a plan
  • service_plan_max_steps_per_flow_reached: The maximum number of steps per flow has been exceeded, this error also applies when trying to submit a flow after downgrading a plan
Available options:
success,
validation_error,
unauthorized,
generic_error,
service_unavailable,
resource_not_found,
step_already_executed,
flow_disabled,
service_plan_max_registered_flows_reached,
service_plan_max_steps_per_flow_reached
​
data
object

Schema that represents any serializable data Base response object containing the record set and record count