Skip to main content
Use the resource groups below to find an endpoint. Each endpoint page describes its parameters, request body, and responses, with generated code examples and an interactive playground. When you open these docs through Settings → API & MCP → View the API docs in Flow, the playground uses your workspace’s API URL. It keeps that URL as you navigate or reload in the same browser tab. Opening another link from Flow updates it. A fresh direct visit defaults to https://backend.branch.flowengineering.com. Enter your personal API key and the required customer header, then supply any project or entity IDs. Start with a GET request to verify access.
The playground makes live requests using your permissions. Write operations change live data. Use a test project and branch when trying writes.
The reference covers Flow’s customer-facing API. For setup, see Authentication and Workspace identifier. For pagination and retry behavior, see API conventions. Download the OpenAPI specification. API changes are included in the existing release notes.