Developers

Build on FlashCat.ai

A real REST API — 71+ domains, org-scoped, bearer-token authenticated. No fabricated OpenAPI spec here: this is an honest index of what's actually deployed, cross-linked into the full Documentation Portal.

1. Authenticate

Every organization authenticates with email/password to get a bearer token. There is no separate API-key system — the same token your users get from logging in is what your integration uses.

POST /api/auth/login
Content-Type: application/json

{ "email": "you@yourcompany.com", "password": "••••••••" }

→ 200 OK
{ "accessToken": "eyJhbGciOi...", "user": { "id": "...", "role": "..." } }

2. Call an endpoint

Send the token as a Bearer Authorization header. Every response is scoped to your organization at the database level — there's no cross-tenant leakage to guard against on your side.

GET /api/crm/leads
Authorization: Bearer <accessToken>

→ 200 OK
[ { "id": "...", "name": "...", "stage": "QUALIFIED", ... }, ... ]

Webhooks

Inbound webhook receivers exist for connected providers today (payment gateway events, marketplace callbacks). Outbound event webhooks for your own integrations are on the roadmap — see the Developer Guide for current status rather than assuming general availability.

API Domains (71+)

Authentication & Identity

AuthPUBLIC

Login, registration, password reset, session/token issuance.

/api/auth
UsersAUTH

User records, profile, role assignment.

/api/users
OrganizationsAUTH

Tenant/organization records and settings.

/api/organizations
SecurityAUTH

MFA enrollment, security policy, sessions.

/api/security

Core Business

CRMAUTH

Clients, leads, pipeline stages.

/api/crm
HRAUTH

Employee records, leave, approvals.

/api/hr
HRMSAUTH

HR management workflows and balances.

/api/hrms
PayrollAUTH

Eligible-employee resolution and payroll runs.

/api/payroll
FinanceAUTH

Invoices, GST breakdown, payments.

/api/finance
ProjectsAUTH

Projects, pipeline stages, tasks.

/api/projects
TicketsAUTH

Support ticket records.

/api/tickets
TimelineAUTH

Cross-module activity stream.

/api/timeline
ZMRAUTH

Zero Manual Reporting -- auto-drafted daily standups.

/api/zmr
MeetingsAUTH

Scheduling, invites, RSVPs.

/api/meetings
ChatAUTH

Channels and direct messages.

/api/chat
CommunicationsAUTH

Org comms channel and template config.

/api/communications
File ManagerAUTH

Document vault and asset library.

/api/file-manager
Client PortalAUTH

External client login, project/invoice/proposal views.

/api/portal
ReportsAUTH

Daily/weekly reports and executive summaries.

/api/reports
LearningAUTH

Course catalog and enrollment tracking.

/api/learning
AutomationsAUTH

Workflow rules and scheduled report jobs.

/api/automations
AttendanceAUTH

Attendance tracking.

/api/attendance
ApprovalsAUTH

Approval chains across modules.

/api/approvals
WorkforceAUTH

Skills graph and workload signal.

/api/workforce
SocialAUTH

Social posts, campaigns, achievements.

/api/social
CalendarAUTH

Calendar events feeding ZMR and meetings.

/api/calendar

AI & Intelligence

AIAUTH

Shared AI provider routing and configuration.

/api/ai
AI StudioAUTH

AI content generation.

/api/ai-studio
AI AssistantAUTH

Chat-based assistant conversations.

/api/ai-assistant
CopilotAUTH

Manager Copilot activity-filtered alerts.

/api/copilot
Knowledge (Business Brain)AUTH

Retrieval over business memory and knowledge base.

/api/knowledge
Revenue IntelligenceAUTH

Campaign ROI, lead scoring, AR leakage.

/api/revenue-intelligence
Journey OrchestratorAUTH

Lead-to-Paid-to-Support lifecycle tracking.

/api/journey
Brand MemoryAUTH

Org-level brand knowledge for AI generation.

/api/brand-memory
Company PulseAUTH

Real-time activity summarization.

/api/company-pulse

Industry Clouds

ConstructionAUTH

BOQ estimation, site progress, material tracking.

/api/construction
ArchitectureAUTH

Design stages, architectural drawings.

/api/architecture
Interior DesignAUTH

Mood boards, material specifications.

/api/interior-design
Structural ConsultantsAUTH

Structural drawings, site audits.

/api/structural
Civil EngineeringAUTH

Material testing, engineering documents.

/api/civil-engineering
Real EstateAUTH

Property listings, site visits, bookings.

/api/realestate
PMCAUTH

Vendor roster, work orders.

/api/pmc
HealthcareAUTH

Patients, appointments, prescriptions.

/api/healthcare
PharmacyAUTH

Medicine inventory, stock ledger.

/api/pharmacy
LaboratoryAUTH

Test orders, lab reports.

/api/laboratory
EducationAUTH

Student enrollments, fee invoices.

/api/education
ManufacturingAUTH

Production orders, quality inspections.

/api/manufacturing
Software/IT ServicesAUTH

Software releases, support incidents.

/api/software
Professional ServicesAUTH

Client engagements, billing milestones.

/api/professional-services
Digital AgencyAUTH

Client retainers, creative briefs, SEO tracking.

/api/agency
Advertising & MediaAUTH

Ad campaigns, media buys.

/api/advertising
ISO ConsultantsAUTH

ISO audits, nonconformances (CAPA).

/api/iso
Auditing & AccountingAUTH

Audit engagements, working papers.

/api/auditing
Legal ServicesAUTH

Legal matters, court hearings.

/api/legal
NGOAUTH

Grant pipeline, donor reporting.

/api/ngo
Import/ExportAUTH

Shipment tracking, customs documents.

/api/trade

Platform & Marketing Content

Industry EnginePUBLIC

Dynamic pricing and pack resolution.

/api/industry-engine
Industry PacksPUBLIC

Curated pack composition.

/api/industry-packs
ModulesAUTH

Module entitlement and marketplace.

/api/modules
SubscriptionsAUTH

Plans, billing cycles.

/api/subscriptions
BillingAUTH

Payment gateway config and recovery sweeps.

/api/billing
LicensingAUTH

Seat/usage quotas.

/api/licensing
Knowledge CenterPUBLIC

Public Knowledge Center articles.

/api/knowledge
DocumentationPUBLIC

Public Documentation Portal pages.

/api/docs
IntegrationsAUTH

Platform integration configuration.

/api/integrations
WebhooksPUBLIC

Inbound webhook receivers for connected providers.

/api/webhooks

Platform Operations (Super Admin)

Super AdminAUTH

Tenant provisioning, plans, revenue, marketplace review.

/api/superadmin
Developer ConsoleAUTH

Pricing config, Knowledge Center CMS, Docs CMS, legal doc editor.

/api/developer
Tenant ProvisioningAUTH

New organization provisioning lifecycle.

/api/tenant-provisioning
MonitoringAUTH

Employee-monitoring admin access and audit logs.

/api/monitoring
Commercial PoliciesAUTH

Coupons, discount rules.

/api/commercial-policies

Building something custom?

Custom development, marketplace listings, and white-label integrations — talk to the team that builds the platform.

Contact Developer Team