Flow.Documentation
ProfessionalAPIs

Test APIs: try any endpoint

5 steps± 4 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · Find the endpoint
  3. Step 3 · Sign in and filter with query parameters
  4. Step 4 · Read the headers of the answer
  5. Step 5 · Your history

Test APIs in the bar on the left is a workbench for all your endpoints: on the left the request and the answer, on the right the documentation Flow makes from the endpoint. You find an endpoint, sign in like a consumer, add query parameters and read the body and headers of the answer. Keys stay only in your session's memory.

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

Open your development environment

In the portal, under Environments, click Development, and there Open. Flow opens in a new tab and you are signed in straight away.

  1. Click Development
Open your development environment · Click Development
  1. Click Open ↗
Open your development environment · Click Open ↗
Step 2 / 5

Find the endpoint

Click Test (Test APIs) in the bar on the left. You see all your endpoints per API; type to search. Choose one: on the left is the request, on the right the documentation — what the endpoint does, how to sign in, the limits and an example.

  1. Click Test APIs
Find the endpoint · Click Test APIs
  1. In Search an endpoint…, type /work-orders
Find the endpoint · In Search an endpoint…, type /work-orders
  1. Click GET /work-orders
Find the endpoint · Click GET /work-orders
Find the endpoint · The endpoint's documentation, next to the request.
Step 3 / 5

Sign in and filter with query parameters

Choose API key and paste a consumer's key; it stays only in this session's memory. Under Query parameters you add a name and value per line: here status=open. Send.

  1. Click API key (X-API-Key)
Sign in and filter with query parameters · Click API key (X-API-Key)
  1. In Key or token, type ••••••••
Sign in and filter with query parameters · In Key or token, type ••••••••
  1. Click + Add
Sign in and filter with query parameters · Click + Add
  1. In Name, type status
  2. In Value, type open
Sign in and filter with query parameters · In Name, type status; In Value, type open
Sign in and filter with query parameters · The request as it goes out, with ?status=open.
  1. Click ▶ Send
Sign in and filter with query parameters · Click ▶ Send
Sign in and filter with query parameters · 200, with the time and the size of the answer.
Sign in and filter with query parameters · Only the open work orders.
Step 4 / 5

Read the headers of the answer

Under Headers you find what the gateway sent back: the type, and with a limit how many calls are left. A workflow endpoint also gives X-Flow-Run: with it you open the run.

  1. Click Headers
Read the headers of the answer · Click Headers
Read the headers of the answer · The headers of the answer.
Step 5 / 5

Your history

On the left under History you find every call of this session, with status and time. Click one to load it again, with the same parameters; the key is stored nowhere.

Your history · The call in the history: 200.

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