Skip to main content

​
API Documentation: Wizflow API

​
Table of Contents

​
Overview

The Wizflow API is designed to enable programmatic access to chatflow data. It is currently limited in scope and may expand significantly in the future.

​
Authentication

The API uses Bearer tokens for authentication.
  • Header Name: Authorization
  • Format: Bearer <TOKEN>
Please contact us at [email protected] to be granted access.

​
Endpoints

​
GET /chatflow/$/openapi

Retrieve OpenAPI specification for a given chatflow. The specification can be used to auto-generate clients, or it can be plugged directly into swagger editors such as this. Unlike all other endpoints, the /openapi endpoint does not require authentication

​
GET /chatflow/$/query

Retrieve chatflow metadata and user responses

​
Request examples

curl --request GET \
  --url 'https://app.wizflow.io/chatflow/${templateKey}/query' \
  --header 'authorization: Bearer ${TOKEN}'

const url = 'https://app.wizflow.io/chatflow/${templateKey}/query';
const options = {
  method: 'GET',
  headers: {
    authorization: 'Bearer ${TOKEN}'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

​
Pagination

The GET /query endpoint will only return a maximum of 100 user records at a time. To get more than 100 records, use pagination. Pagination can be used by simply appending a search (query) parameter to the URL of the request. For example: 
https://app.wizflow.io/chatflow/${templateKey}/query?page=5
The API response contains a totalEntries integer property indicating the total amount of user entries available. It also optionally includes previousPageUrl and nextPageUrl properties to programatically fetch records from multiple pages. Passing an invalid value as the page search parameter will make the API default to page=1