Flows

Get Flows API endpoint enables you to retrieve a list of published flows as a JSON object. To use this API, you will need to include the user_idof your logged-in user and app_key as a query parameter and your api_keyin the request header to authenticate the request. 

In this article, we will provide examples of HTTP and cURL code samples, along with information on the response status codes and response fields that you can expect.

Get flows 

GET https://app.integry.io/partners/api/bundle/<bundle_id>/templates

Required parameters

1. Query parameters:
   1. user_id:The unique ID of the logged-in user for whom you are retrieving the list of flows
   2. app_key:The unique public key of your app
2. Headers: Add your api-key to the request header to authenticate the request.

Code samples

HTTP

GET https://app.integry.io/partners/api/bundle/<bundle_id>/templates?user_id=<user_id>&app_key=<your_app_key>
api-key: <your_api_key>

cURL

curl --request GET 'https://app.integry.io/partners/api/bundle/<bundle_id>/templates/?user_id=<user_id>&app_key=<your_app_key>' \
--header 'api-key: <your_api-key>'

HTTP response status codes

Sample response

[
    {
        "created_at": "2020-02-21 06:22:26",
        "description": "Synchronize all Typeform responses to Sendinblue contacts",
        "integration_setup_link": "/integration_setup#templates_inline/1903/start?user_id=6384c7029b21ce39205877c7&app_key=8a1e5f97-4aec-4d8f-b3fc-c641bb195ca4&hash=2367223143f8fab7a130fb2c6a5b952dcd559f897cb31dae82a5b8fed9f87dfc&bundle_id=71",
        "link": "http://app.integry.io/template/1903/",
        "publishing_status": "PUBLISHED",
        "product_info": {
            "category": [
                {
                    "description": "Forms & Surveys",
                    "id": 56,
                    "slug": "forms-surveys",
                    "name": "Forms & Surveys"
                }
            ],
            "support_email_address": null,
            "color": null,
            "tags": "",
            "twitter_url": null,
            "icon_url": "https://storage.googleapis.com/app-services-prod--bucket/public/e5fe8ecb-5718-42fa-8dfa-a94a41f5761c.png",
            "facebook_url": null,
            "linkedin_url": null,
            "privacy_policy_url": "https://admin.typeform.com/to/dwk6gt",
            "terms_and_conditions_url": "https://admin.typeform.com/to/dwk6gt",
            "app_documentation_link": "https://developer.typeform.com/get-started/",
            "support_website_link": null,
            "images": [
                {
                    "image_url": "https://storage.googleapis.com/app-services-prod--bucket/public/746118b7-3893-4d85-b7a7-8c1a61703680.png",
                    "id": 11783
                },
                {
                    "image_url": "https://storage.googleapis.com/app-services-prod--bucket/public/73be29b7-bfd9-410a-8dc7-de449439e7a4.png",
                    "id": 11784
                },
                {
                    "image_url": "https://storage.googleapis.com/app-services-prod--bucket/public/a77d8c80-6ee4-4659-ac01-da3a122d8eff.png",
                    "id": 11785
                }
            ],
            "long_description": "\nTypeform is an online software service designed to collect data through personalized and engaging forms. Create conversational forms, surveys, questionnaires, and they guarantee a higher response. Ask away aesthetically online across any device! Using inbuilt templates, Typeform lets you ask beautifully. Make your data collection more fun and fanciful for yourself and your customers. Typeform incorporates form builder, survey maker, quizzes, order forms, lead generation and much more. The forms created automatically sync with Integry.",
            "website_link": "https://www.typeform.com/"
        },
        "id": 1903,
        "name": "Typeform contacts"
    },
....
]

Response fields

• created_at: date and time of when the flow was published
• description: the short description on the flow card that usually explains how the flow works
• integration_setup_link: the link that a user is taken to when they click on the "Setup" button on the flow card
• link: the link of a particular flow on Integry's server
• publishing_status: the status of a flow. This endpoint only return the flows with a "PUBLISHED" status
• product_info: the category of apps being used in a flow. For example, CRM, Email, Sales, etc.
• icon_url: public URL of the flow icon
• long_description: app description that appears on the app page
• id: ID of a flow
• name: flow name