Flow.Documentation
ProfessionalAPIs

An API's description: OpenAPI and WSDL

4 steps± 3 minVideoVerified 22 Oct 2026
  1. Step 1 · Open your development environment
  2. Step 2 · Switch on SOAP and public documentation
  3. Step 3 · Read the OpenAPI description
  4. Step 4 · Let the endpoint speak SOAP too

Flow describes every API itself, from what you build: an OpenAPI description for REST and a WSDL for endpoints that also speak SOAP. By default only callers with a key or token for that API can read the description. With Public documentation anyone can read it — partners' developers build against it without an account — while calling it still requires signing in.

Watch the whole guide as a video4 steps in one film
Step 1 / 4

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 / 4

Switch on SOAP and public documentation

Open the API. Under Protocols and security tick SOAP if consumers also use SOAP, and Description public to make the description readable for everyone. Calling it still requires signing in.

  1. Click the API
Switch on SOAP and public documentation · Click the API
  1. Click SOAP
Switch on SOAP and public documentation · Click SOAP
  1. Click Description public
Switch on SOAP and public documentation · Click Description public
  1. Click Save API
Switch on SOAP and public documentation · Click Save API
Switch on SOAP and public documentation · In plain language: reachable through REST and SOAP.
Step 3 / 4

Read the OpenAPI description

The link OpenAPI of this API opens the description in a new tab, without signing in: paths, methods, the request schema with required fields, the responses and how to sign in.

  1. Click OpenAPI of this API ↗
Read the OpenAPI description · Click OpenAPI of this API ↗
Read the OpenAPI description · The endpoint's path in the description.
Step 4 / 4

Let the endpoint speak SOAP too

Open the endpoint and tick SOAP. The SOAP operation is named after the endpoint's name; you can override it. After saving, a link to the WSDL appears next to the address.

  1. Click the endpoint
Let the endpoint speak SOAP too · Click the endpoint
  1. Click SOAP
Let the endpoint speak SOAP too · Click SOAP
  1. Click Save endpoint
Let the endpoint speak SOAP too · Click Save endpoint
Let the endpoint speak SOAP too · The link WSDL ↗ next to the address: the description for SOAP tools, with the operation and its messages, derived from the same request schema.

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