Skip to content

Getting started

Base URL

Point clients at the API base URL for your environment—for example https://api.example.com. Your workspace or administrator provides this value. Examples below use a placeholder:

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

GraphQL endpoint

GraphQL accepts HTTP POST with a JSON body at POST {BASE_URL}/ with payload {"query":"...", "variables":{...}}.

For authenticated calls, send:

Authorization: Bearer <session_token>

Use a session token from your app’s sign-in flow (Simple Feature Requests uses Clerk on the official web apps; custom integrations should obtain a compatible JWT from the same identity setup your deployment uses).

REST health check

curl -s "$BASE_URL/health"

Returns {"status":"ok"} when the service is up.

Quick GraphQL check

curl -s -X POST "$BASE_URL/" \
  -H "Content-Type: application/json" \
  -d '{"query":"{ hello }"}'

Data model essentials

  • Team → Projects → Boards → Requests.
  • Statuses belong to a board (not directly to a project).
  • Tags belong to a project; requests link to tags via request tags.

See API endpoints for queries and mutations, and SDK quick start to use the client from TypeScript.

Schema reference

The authoritative field and operation list for your deployment comes from GraphQL introspection on {BASE_URL}/, or from any published schema artifact your provider supplies.