Who this documentation is for
Business integrators
Product and engineering teams connecting their Tyms business to internal tools, billing systems, or workflows. You use the business secret key (
tyms_sk_...) from Settings → API.Partners
Referral business partners (distributors) who onboard new Tyms businesses and may grant Plus or credits from partner holding. You use a partner key for routes under API reference → Partners, then each business’s secret key for all other endpoints.
What you can build
- AI-assisted creates — Invoices, bills, expenses, income, journals, contacts, chart-of-accounts lines, and bank statement lines from prompts plus optional files (see Attachments).
- CRUD and reads — List, get, update, and delete the same record types the app manages, scoped to one business per key.
- Banking — List banks and bank transactions; upload and categorize activity through the same AI-assisted pipeline as the app.
- Financial reports — Income statement, balance sheet, trial balance, and cash flow aligned with in-app Tyms reports (Income statement and sibling endpoints under Reports).
Environments
The Developer API runs in production and sandbox. Paths, request bodies, and headers are the same in both environments — only the host and your API keys change.| Environment | Base URL | Use for |
|---|---|---|
| Production | https://api.usetyms.com/v1/adam | Live businesses and real financial data |
| Sandbox | https://staging-api.usetyms.com/v1/adam | Pre-production integration and testing |
Sandbox access is not self-service. Email developer@usetyms.com to request a sandbox account and credentials before calling the staging host. Sandbox keys work only on the sandbox base URL; production keys from the Tyms app work only on production.
GET /auth/validate on production is https://api.usetyms.com/v1/adam/auth/validate; on sandbox it is https://staging-api.usetyms.com/v1/adam/auth/validate.
Where to go next
Quickstart
Validate a key and send your first request in minutes.
Concepts
How AI creates, async vs direct processing, and how reports relate to the product.
Authentication
Business keys, partner keys, headers, and subscription expectations.
OAuth 2.0
Connect Tyms users to your integration app without sharing secret keys.
API reference
Complete endpoint documentation lives under the API reference tab — start from the overview.