TorbatYar/docs/reference/api-reference.md

API Reference

Index of HTTP APIs. Detailed contracts live in services-contracts.md. Template: api-template.md.

Core Platform

Base: Core service (/api/v1)

Area	Doc section
Health	GET /health
Tenants / Domains / Plans / Features / Subscription / Entitlement check	services-contracts §5
Onboarding & Tenant Context	services-contracts §7
OTP Auth	architecture identity + Core routers /auth/otp/*
Public tenant site	GET /api/v1/public/tenant-site (see contracts updates / Core routers)

Identity & Access

Base: Identity service (/api/v1)

Area	Doc section
OIDC BFF + mobile auth	services-contracts §8

Accounting

Base: Accounting service port 8002 (/api/v1)

See service OpenAPI at /docs and phases/Accounting.

CRM

Base: CRM service port 8003 (/api/v1) — public host crm.torbatyar.ir

Area	Paths
Leads	/api/v1/leads (+ assign/delete/restore)
Contacts	/api/v1/contacts
Organizations	/api/v1/organizations
Pipelines / stages	/api/v1/pipelines
Opportunities	/api/v1/opportunities (+ /stage, /win, /lose, stage-history)
Playbooks / forecasts / goals / targets / win-loss	/api/v1/playbooks, /forecasts, /goals, /targets, /win-loss/*
Activities	/api/v1/activities (+ /complete, participants, reminders)
Tasks / Meetings / Calls	/api/v1/tasks, /meetings, /calls
Timeline / Comments / Mentions	/api/v1/timeline, /comments, /mentions/*
Bookmarks / Team	/api/v1/bookmarks, /favorites, /team-*, /collaboration-preferences/{user_id}
Quotes	/api/v1/quotes
Lookups / tags / addresses / notes / attachments / custom fields / audit	/api/v1/lookups/*, /tags, /addresses, /notes, /attachments, /custom-fields, /audit

Phase docs: crm-phase-6-0.md … crm-phase-6-3.md

Future Services

Each new module adds an API sheet using the template and links it here.

Related Documents

• Services Contracts
• Authorization Architecture
• Event Catalog