Skip to content

API Overview

The Simple Feature Requests API is a GraphQL-first HTTP API for managing teams, projects, boards, feature requests, votes, comments, attachments, and related resources.

Base URL

Use the origin your deployment provides (no trailing path). Examples in this documentation use BASE_URL:

export BASE_URL=https://api.example.com

REST

There is one REST endpoint:

  • GET /health — Liveness/readiness check. Returns {"status":"ok"}. See Endpoints.

GraphQL

The primary API is GraphQL over HTTP POST with Content-Type: application/json.

  • URL: POST {BASE_URL}/ (the TypeScript SDK uses the same path).
  • Body: {"query": "...", "variables": { ... }} — variables is optional.

For the complete schema for your environment, use GraphQL introspection against your API, or follow your provider’s published schema documentation.

Next steps

  • Authentication — JWT authentication, public projects, and permissions (summary).
  • Endpoints — GraphQL operations with curl examples.
  • Errors — HTTP status codes and error messages returned by the API.
  • Client SDK — TypeScript/JavaScript SDK with typed methods and error handling.