Manage Flow

Flows are the core of Typeflow.us - they are the configurations that will define how your PDFs are generated. On this page, we'll dive into the different flow endpoints you can use to manage flows programmatically.

The flow model

The flow model contains all the information about the flows you have created, including the name, description, and configuration.

Properties

Name
appId
Type
string
Description
The airtable base id.
Name
tableId
Type
string
Description
The airtable table id. This table id must be part of the airtable base id.
Name
apiKey
Type
string
Description
The airtable api key to authenticate the requests.

GET/api/retrieve-all-flows

Retrieve flows from an Airtable table

This endpoint allows you to retrieve all flows from an Airtable table.

Mandatory attributes

Name
appId
Type
string
Description
The airtable base id.
Name
tableId
Type
string
Description
The airtable table id. This table id must be part of the airtable base id.
Name
apiKey
Type
string
Description
The airtable api key to authenticate the requests.

Request

GET

/api/retrieve-all-flows

curl -G https://app.typeflow.us/api/retrieve-all-flows \
  -d appId="{appId}" \
  -d tableId="{tableId}" \
  -d apiKey="{apiKey}"

Response

{
"data": [
    {
        "flow_name": "Je fais un petit test",
        "gdoc_name": "Typeflow - Template Sales quote - k@typeflow.us",
        "airtable_base_name": "Demo",
        "airtable_base_schema_name": "Eleve",
        "automationId": "a164c89f44bb4940b5d98cc7d89ae8fb",
        "users": {
            "email": "k@typeflow.us"
        }
    },
    {
        "flow_name": null,
        "gdoc_name": "Product Specification Template",
        "airtable_base_name": "Demo",
        "airtable_base_schema_name": "Eleve",
        "automationId": "de4bd7f0599647b5bb875be133339d78",
        "users": {
            "email": "k@typeflow.us"
        }
    },
]
}

POST/api/delete-flow

Delete a flow created

This endpoint allows you to delete a flow created from an Airtable table.

Mandatory attributes

Name
flow_id
Type
string
Description
The flow_id is linked to your configuration

Request

POST

/api/delete-flow

curl -G https://app.typeflow.us/api/delete-flow \
  -d {flow_id: flow_id }

Response

{
"data": "success"
}