API Reference

The SupportFlow REST API gives you full control over your support platform. All endpoints use JSON and follow REST conventions.

Base URL

https://support.yourdomain.com/api/support/{appSlug}

Replace {appSlug} with your app's slug.

Key Concepts

REST API

Standard HTTP methods (GET, POST, PATCH, DELETE) with JSON payloads.

JWT Auth

Pass user tokens in the Authorization header for authenticated endpoints.

Rate Limiting

Help content API requests are limited by plan: 10,000/day on Starter and Team, 100,000/day on Agency.

Authentication

Some endpoints require JWT authentication. Pass the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

See the JWT Integration Guide for details on generating tokens.

Endpoints

Articles

Knowledge base article management

View all
GET/api/support/{app}/articles

List articles

GET/api/support/{app}/articles/{slug}

Get article by slug

Issues

Support ticket management

View all
GET/api/support/{app}/issuesJWT Required

List user issues

POST/api/support/{app}/issuesJWT Required

Create issue

Help Content

Tooltips, onboarding, and contextual help

View all
GET/api/support/{app}/help-content

Get help content

AI Chat

AI-powered support chat

View all
POST/api/support/{app}/chatJWT Required

Send chat message