Tristar API Documentation
These pages provide endpoint-focused documentation for the Tristar API v2 controllers. Each operation page includes request schema, expected response schema, JSON samples, validation notes, and a link back to Swagger.
Authentication And Tenant Resolution
Most endpoints require Authorization: Bearer {token} plus tenant resolution through a tenant subdomain or the X-Api-Key header. The API key goes in the header, not in clientCode. Contacts obtain a token from Auth/Token. Employees obtain a token from Employee/SignIn using Server check-in credentials. Anonymous authentication endpoints still participate in tenant resolution unless explicitly exempted by middleware.
See Authentication for the header flow and curl examples.
Guides
- Authentication — API key header, contact token, and how to call authorized endpoints.
- Order Lifecycle: Drafts, Export, And Work Orders — how draft web order ids become exported work order ids across every order type.
- Webhooks — outbound HTTPS event delivery, signature verification, and event catalog.
Endpoint Groups
- Attorney
- Auth
- BillTo
- Contact
- CopyOrder
- CopyPhrases
- CountyRecordingOrder
- Court
- CourtOrder
- Customer (Account)
- DeliveryOrder
- DraftOrder
- Diagnostics
- Diligence
- DocumentTypes
- Employee
- FileAndServeOrder
- FillInPhrases
- FirmType
- InvestigationOrder
- Impersonate
- Invoice
- LawsPracticed
- Matter
- NextAction
- Notes / Status
- OrderExport
- Payments
- PreBill
- PhotoCopyOrder
- ProcessOrder
- ProcessPDF
- ProcessStatus
- ProofOfService
- RecordTypes
- ReferenceData
- Registration
- ReleaseType
- Reports
- Session
- ShipRecordsVia
- StatusPhrases
- WinCopyMilestone
- WinCopyStatus
- WorkPerformed