Public API

Quantify’s public API is an OAuth-protected HTTP API for external integrations.

Every page in this section is derived from the current implementation under src/Quantify.Api.Public and related shared DTOs. Example values are illustrative, but field names, paths, scopes, pagination behavior, and error envelopes are documented to match the code.

Quick start

Set a few shell variables before trying the examples:

export API_BASE_URL="https://api.quantify.example.com"
export ACCESS_TOKEN="replace-with-access-token"
export CLIENT_ID="replace-with-client-id"
export CLIENT_SECRET="replace-with-client-secret"

Base paths

Path	Purpose
/oauth	Token issuance and token revocation
/v1	Public resource API
/health, /healthz, /readyz	Liveness and readiness endpoints

Read this first

Page	Covers
Authentication	OAuth grant types, token examples, revocation, and scopes
Conventions	Headers, response shapes, pagination, errors, rich text, and enum codes
Health	Probe endpoints

Resource groups

Page	Main endpoints	Scope
Workspace	/v1/workspace and issue catalogs	workspace:read
Members	/v1/members	members:read
Teams	/v1/teams and repository context	teams:read
Projects	Project reads	projects:read
Project Mutations	Project writes and project links	projects:write
Issues	Issue reads	issues:read
Issue Comments And Agent Threads	Comment and agent-thread reads and writes	issues:read, issues:write
Issue Assets And Links	Activity, attachments, links, and subissues	issues:read, issues:write for link writes
Issue Mutations	Issue create, update, and delete	issues:write

Notes

• Collection endpoints return { results, pagination }
• Detail endpoints return the resource directly
• OAuth endpoints require application/x-www-form-urlencoded
• /v1 write endpoints accept JSON
• Several fields that look like enums serialize as numeric codes. See Conventions.