TypeScript SDK
Use the generated @orvelt/business client from a typed server application.
@orvelt/business is the generated TypeScript client for the public Business API. It exposes one function for each public operation and validates responses with generated Zod schemas.
Configure the client
Set the API key, production or staging base URL, and fetch options.
Handle responses
Use data, error, request, and response without losing typed errors.
API reference
Find the operation and request shape for each Business API capability.
Grouped operations
Find the function for each API job
Project operations are grouped by resource at the top level, with organization-level operations under knowledgeBase and webhooks. Examples include goals.list, questions.create, opinions.list, preverifiedLinks.create, preverifiedLinks.sendEmail, knowledgeBase.add, and webhooks.destinations.upsert. Parameters use Hey API's flat structure, so call goals.list({ projectId, page, limit }) without nested path, project, query, or body objects. For repeated calls against one project, useProject('PROJECT_ID') binds the project ID and exposes the same resource groups without requiring projectId in each call. The API reference shows the exact function for each endpoint.
Runtime support
Use a server runtime with Fetch
The package uses the Fetch API and works in server runtimes that provide fetch, including Bun and modern Node.js. Supply a custom fetch implementation through the client options when your runtime needs one.