Flow.Documentation
ProfessionalWorkflows

HTTP request: call an API

5 steps± 4 minVideoVerified 22 Oct 2026
  1. Step 1 · Open Flow and create a workflow
  2. Step 2 · Call the API
  3. Step 3 · Use the answer
  4. Step 4 · Put the steps in one line and save
  5. Step 5 · Run

With HTTP request a workflow calls another API: a supplier, a web shop, an internal system. Through a connection the address and the key stay in one place, on the server; in the step you only put the path. The answer gets a name, so the next steps can get at it.

Watch the whole guide as a video5 steps in one film
Step 1 / 5

Open Flow and create a workflow

In the portal, under Environments, click Development and there Open; Flow opens in a new tab. There, click ＋ next to General, choose New workflow and give it a name. A new workflow starts with an Event trigger: the point where it begins.

  1. Click Development
Open Flow and create a workflow · Click Development
  1. Click Open ↗
Open Flow and create a workflow · Click Open ↗
  1. Click Add to General
Open Flow and create a workflow · Click Add to General
  1. Click New workflow
Open Flow and create a workflow · Click New workflow
  1. In Workflow name, type Guide · look up order status
Open Flow and create a workflow · In Workflow name, type Guide · look up order status
Step 2 / 5

Call the API

Put the order number in the sample data. Add HTTP request and choose the connection: the URL field is then the path after the base URL, with {{order_id}} in it. Method GET fetches data. Call the result partner.

  1. Click the step ‘Event trigger’
Call the API · Click the step ‘Event trigger’
  1. Click Code
Call the API · Click Code
  1. In the sample data, type `{
Call the API · In the sample data, type `{; ;
  1. Click Add node
Call the API · Click Add node
  1. Click HTTP request
Call the API · Click HTTP request
  1. In Name, type Fetch order
  2. In Connection, choose Guide · partner API
Call the API · In Name, type Fetch order; In Connection, choose Guide · partner API
Call the API · Method: GET.
  1. In URL or path, type /orders/{{order_id}}
  2. In Store the result as, type partner
Call the API · In URL or path, type /orders/{{order_id}}; In Store the result as, type partner
  1. Click the dot of ‘Event trigger’
Call the API · Click the dot of ‘Event trigger’
  1. Click the dot of ‘Fetch order’
Call the API · Click the dot of ‘Fetch order’
Step 3 / 5

Use the answer

The answer is in partner: partner.status is the HTTP status code, partner.body is what the API sent back. Add Transform data and take over the order's status with {{partner.body.status}}.

  1. Click Add node
Use the answer · Click Add node
  1. Click Transform data
Use the answer · Click Transform data
  1. In Name, type Summarise
Use the answer · In Name, type Summarise
  1. Click Remove field
Use the answer · Click Remove field
  1. Click Remove field
Use the answer · Click Remove field
  1. In New field, type order_status
  2. In order_status, type {{partner.body.status}}
Use the answer · In New field, type order_status; In order_status, type {{partner.body.status}}
  1. Click the dot of ‘Fetch order’
Use the answer · Click the dot of ‘Fetch order’
  1. Click the dot of ‘Summarise’
Use the answer · Click the dot of ‘Summarise’
Step 4 / 5

Put the steps in one line and save

Select the steps (click the first, and the others while holding Shift) and click Align horizontally: they then stand in one line and you read the workflow from left to right; a branch (such as No of an If / Else) gets its own row below. Fit to view puts everything in sight; then Save.

  1. Click ‘Event trigger’
Put the steps in one line and save · Click ‘Event trigger’
  1. Click ‘Fetch order’ while holding Shift
Put the steps in one line and save · Click ‘Fetch order’ while holding Shift
  1. Click ‘Summarise’ while holding Shift
Put the steps in one line and save · Click ‘Summarise’ while holding Shift
  1. Click Align horizontally
Put the steps in one line and save · Click Align horizontally
  1. Click Fit to view
Put the steps in one line and save · Click Fit to view
  1. Click Save
Put the steps in one line and save · Click Save
Step 5 / 5

Run

At the bottom is the call with the status code: GET → 200. You do not see the key anywhere; Flow adds it on the server. Under Data after the run is the order's status.

  1. Click Run
Run · Click Run
Run · Status: Completed.
Run · GET → 200: the partner answered.
Run · order_status: shipped.

This guide was carried out step by step on 22 Oct 2026 by an automated test on Flow (version 3e563176).