# Hailer Documentation

> Documentation for Hailer core and Hailer related services

## Search

Search these docs directly: `GET https://docs.hailer.com/search?q=<query>` - parameters: `q` (required),
`limit` (default 10, max 50), `format` (`json` default, or `md` for markdown). Results return the
best-matching section of each page as raw markdown, so the answer is often in the response itself.

Example: https://docs.hailer.com/search?q=create+activity&format=md

Every page below links to its raw markdown; drop the `.md` suffix for the rendered page.

## Documentation

- [index](https://docs.hailer.com/index.md)
- [Documentation Standard](https://docs.hailer.com/about/index.md): How Hailer documentation is organized — one site, docs co-located with code, endpoint reference generated from source.
- [Search & Navigation](https://docs.hailer.com/about/search-and-navigation.md): How search works on this site, and how agents should discover, search, and read the documentation.
- [API](https://docs.hailer.com/api/index.md): Getting started with the Hailer API - base URLs, transports, authentication with @hailer/cli, your first call, and the core data model.
- [Endpoints](https://docs.hailer.com/api/endpoints/index.md): The Hailer API endpoint reference, split by generation - v3 (current) and v2 (older, still in use).
- [legacy](https://docs.hailer.com/api/endpoints/legacy/index.md): The Hailer legacy API, grouped by backend module.
- [Activities](https://docs.hailer.com/api/endpoints/legacy/activities.md): Original activity endpoints: create, update, load, search, follow, linked activities, and phase counts.
- [Calendar](https://docs.hailer.com/api/endpoints/legacy/calendar.md): Calendars and events: create, update and load calendars and events, invites, repeat series, and iCal links.
- [Company (Workspace)](https://docs.hailer.com/api/endpoints/legacy/company-workspace.md): Workspace (company) management: accounts, users, teams, invites, custom property fields, and general options.
- [Files](https://docs.hailer.com/api/endpoints/legacy/files.md): File management: listing, file properties and metadata, tags, removal, and uploads.
- [Network groups](https://docs.hailer.com/api/endpoints/legacy/group.md): User group management within a workspace: create, get, update, and remove groups.
- [Login](https://docs.hailer.com/api/endpoints/legacy/login.md): Original login endpoints: email/password, Google and Apple sign-in, and session resume.
- [Messenger](https://docs.hailer.com/api/endpoints/legacy/messenger.md): Messaging: discussions, messages, invites, unread counts, settings, and typing state.
- [Phase](https://docs.hailer.com/api/endpoints/legacy/phase.md): Workflow phase management: create, update and remove phases, field options, phase info, and following.
- [Process (Workflow)](https://docs.hailer.com/api/endpoints/legacy/process-workflow.md): Workflow (process) management: creation, templates, fields, and document templates.
- [User](https://docs.hailer.com/api/endpoints/legacy/user.md): User profile and settings: profile info, settings, password change, profile pictures, and companies.
- [Wall](https://docs.hailer.com/api/endpoints/legacy/wall.md): Social wall: posts, comments, likes, pins, follows, and read state.
- [REST routes](https://docs.hailer.com/api/endpoints/rest.md): The Hailer HTTP REST routes - file and image download, upload, insight export, and calendar feeds. These are plain HTTP endpoints, not RPC.
- [v2](https://docs.hailer.com/api/endpoints/v2/index.md): The Hailer v2 API, grouped by backend module.
- [Activities](https://docs.hailer.com/api/endpoints/v2/activities.md): Activity operations: copy, list, kanban, timeline, files, and field evaluation.
- [Calendar](https://docs.hailer.com/api/endpoints/v2/calendar.md): Calendars and events: listing, access, membership, and permissions.
- [Core](https://docs.hailer.com/api/endpoints/v2/core.md): Core API for managing users, networks, teams, groups, accounts, processes, calendars, tags, and apps.
- [Discussion](https://docs.hailer.com/api/endpoints/v2/discussion.md): Discussions and messages: sync, edit, react, mute, and start meetings.
- [Forms](https://docs.hailer.com/api/endpoints/v2/forms.md): Public forms: render a workflow form, create activities from submissions, and search.
- [Network](https://docs.hailer.com/api/endpoints/v2/network.md): Workspaces (networks): creation, licensing, invites, copying, and marketplace products.
- [Phase](https://docs.hailer.com/api/endpoints/v2/phase.md): Workflow phase membership and permissions.
- [Process](https://docs.hailer.com/api/endpoints/v2/process.md): Workflow (process) configuration: metadata, copying, members, permissions, public forms, and translations.
- [Search](https://docs.hailer.com/api/endpoints/v2/search.md): Global search across workspace content.
- [Tags](https://docs.hailer.com/api/endpoints/v2/tags.md): Tags: list, filter, manage, and tag or untag content.
- [User](https://docs.hailer.com/api/endpoints/v2/user.md): User registration, email verification, invites, and profile.
- [v3](https://docs.hailer.com/api/endpoints/v3/index.md): The Hailer v3 API, grouped by backend module.
- [Activity](https://docs.hailer.com/api/endpoints/v3/activity.md): Create, read, update, remove and manage activities (the records inside workflows).
- [Activity import](https://docs.hailer.com/api/endpoints/v3/activity-import.md): Import activities from a file.
- [Activity kanban](https://docs.hailer.com/api/endpoints/v3/activity-kanban.md): Kanban board views of activities.
- [Activity list](https://docs.hailer.com/api/endpoints/v3/activity-list.md): List and query activities.
- [App](https://docs.hailer.com/api/endpoints/v3/app.md): Apps: list, get, create, update and manage app members.
- [App icon](https://docs.hailer.com/api/endpoints/v3/app-icon.md): App icon generation.
- [Core](https://docs.hailer.com/api/endpoints/v3/core.md): Pre-authentication helpers: proof-of-work challenges and email checks used during signup and login.
- [Discussion](https://docs.hailer.com/api/endpoints/v3/discussion.md): Discussions and messages: send, edit, load, and manage discussion membership.
- [Feed](https://docs.hailer.com/api/endpoints/v3/feed.md): Feed (wall) posts and comments.
- [Insight](https://docs.hailer.com/api/endpoints/v3/insight.md): Insights: run, copy, and read insight data.
- [Link](https://docs.hailer.com/api/endpoints/v3/link.md): Links between activities.
- [Login](https://docs.hailer.com/api/endpoints/v3/login.md): Authenticate and obtain a session: email/password, SSO (Apple, Google, Microsoft, OpenID), login tokens, and resume.
- [Metrics](https://docs.hailer.com/api/endpoints/v3/metrics.md): Workspace metrics and usage data.
- [Poll](https://docs.hailer.com/api/endpoints/v3/poll.md): Create and vote on polls.
- [Product](https://docs.hailer.com/api/endpoints/v3/product.md): Marketplace products and installs.
- [Role](https://docs.hailer.com/api/endpoints/v3/role.md): Roles and permission assignments.
- [Template](https://docs.hailer.com/api/endpoints/v3/template.md): Workflow and activity templates.
- [User](https://docs.hailer.com/api/endpoints/v3/user.md): The current user, look up users, and list workspace members.
- [User API keys](https://docs.hailer.com/api/endpoints/v3/user-api-key.md): Create and manage personal API keys for programmatic access.
- [User navigation](https://docs.hailer.com/api/endpoints/v3/user-navigation.md): The current user's app navigation (pinned and tracked apps).
- [Video call](https://docs.hailer.com/api/endpoints/v3/video-call.md): Video call sessions.
- [Workflow](https://docs.hailer.com/api/endpoints/v3/workflow.md): Install workflow templates.
- [Workspace](https://docs.hailer.com/api/endpoints/v3/workspace.md): Workspace management and token balance operations.
- [Insights](https://docs.hailer.com/api/guides/insights.md): What Hailer insights are and how to use them from the API - author in the UI or with @hailer/sdk, read the result, and expose it outside Hailer as a public CSV or JSON link.
- [Permissions](https://docs.hailer.com/api/guides/permissions.md): How Hailer's layered permission system works and how to check permissions from an integration - workspace roles, workflow and phase permissions, custom role permits, and resolution order.
- [Hailer App SDK](https://docs.hailer.com/app-sdk/index.md): Client library for building Hailer Apps — web apps that run inside the Hailer frontend and call the platform through the host session, no auth or tokens at runtime.
- [API](https://docs.hailer.com/app-sdk/api/index.md): The HailerApi module-by-module API — every module, method, argument, return type, and its host-side behavior.
- [activity](https://docs.hailer.com/app-sdk/api/activity.md): hailer.activity — list, get, create, update, remove and print activities, plus the kanban and ball sub-modules. Workflows, phases, and fields can be addressed by key.
- [admin](https://docs.hailer.com/app-sdk/api/admin.md): hailer.admin — instance-administration endpoints (workspaces, users, subscriptions, invoices, revenue, token transactions, referrals). Internal — not for third-party apps.
- [app](https://docs.hailer.com/app-sdk/api/app.md): hailer.app — update the running app's config, and marketplace product lookups for the app.
- [file](https://docs.hailer.com/app-sdk/api/file.md): hailer.file — get and upload files in Hailer's file storage, and add or remove tags.
- [http](https://docs.hailer.com/app-sdk/api/http.md): hailer.http — call third-party services through Hailer's server-side proxy with fetch, upload, and openWebSocket.
- [insight](https://docs.hailer.com/app-sdk/api/insight.md): hailer.insight — list insights, read insight data, and update an insight.
- [metrics](https://docs.hailer.com/app-sdk/api/metrics.md): hailer.metrics — read time-series usage metrics with aggregation, grouping, and label filters, plus admin workspace/user lookups for filtering.
- [payment](https://docs.hailer.com/app-sdk/api/payment.md): hailer.payment — pricing and purchases for marketplace products. Internal — not intended for third-party apps.
- [permission](https://docs.hailer.com/app-sdk/api/permission.md): hailer.permission — the current user's permission map, optionally scoped to a workspace.
- [product](https://docs.hailer.com/app-sdk/api/product.md): hailer.product — full CRUD on your own marketplace products.
- [public](https://docs.hailer.com/app-sdk/api/public.md): hailer.public — endpoints callable without a Hailer session, talking directly to the public backend. The only namespace usable in outside mode.
- [team](https://docs.hailer.com/app-sdk/api/team.md): hailer.team — list teams grouped by workspace.
- [ui](https://docs.hailer.com/app-sdk/api/ui.md): hailer.ui — command the host Hailer frame to open activity and discussion panels, insight and function editors, and snackbars.
- [user](https://docs.hailer.com/app-sdk/api/user.md): hailer.user — the current user, look up a user by id, and list members of the current workspace.
- [workflow](https://docs.hailer.com/app-sdk/api/workflow.md): hailer.workflow — list and get workflows, and install a workflow template into a workspace.
- [workspace](https://docs.hailer.com/app-sdk/api/workspace.md): hailer.workspace — current and available workspaces, create workspaces (private apps only), and product/template install lookups.
- [Getting started](https://docs.hailer.com/app-sdk/getting-started.md): Scaffold a Hailer App, register a Local Development app, instantiate HailerApi, and make your first authenticated call.
- [App lifecycle](https://docs.hailer.com/app-sdk/guides/app-lifecycle.md): How a Hailer App connects to the host frame — the register handshake, the Options callbacks, inside vs outside mode, and info().
- [Keys](https://docs.hailer.com/app-sdk/guides/keys.md): Address workflows, phases, and fields by a stable key instead of a generated id, so an app works across workspaces without hard-coding ids.
- [Private vs workspace apps](https://docs.hailer.com/app-sdk/guides/private-vs-workspace.md): The scoping model that silently changes what almost every App SDK method returns — personal (private) apps see all workspaces, workspace apps are locked to one.
- [Publishing](https://docs.hailer.com/app-sdk/guides/publishing.md): Push a built Hailer App bundle to a Hailer instance or the marketplace with the publish CLI — auth, environment selection, creating apps, and env-file precedence.
- [Signals](https://docs.hailer.com/app-sdk/guides/signals.md): Subscribe to live changes in Hailer from your app — the fixed whitelist of signal names, their converted payloads, and how to handle them.
- [Types](https://docs.hailer.com/app-sdk/types.md): Catalogue of the types exported by @hailer/app-sdk — entities, activity values, insights, permissions, products, payments, errors, and admin shapes.
- [CLI](https://docs.hailer.com/cli/index.md): @hailer/cli - an interactive console and a programmatic Node.js client for the Hailer API.
- [Interactive Console](https://docs.hailer.com/cli/interactive-console.md): The hailer-cli REPL - connect to Hailer and call API endpoints from the terminal.
- [Programmatic Usage](https://docs.hailer.com/cli/programmatic-usage.md): The @hailer/cli Client class - connect, authenticate, make requests, receive signals, upload files.
- [Help](https://docs.hailer.com/help/index.md): Hailer Help Center - product guides, FAQ, and workspace setup, in English and Finnish.
- [English](https://docs.hailer.com/help/english/index.md): Hailer Help Center in English - general info, guides for all users, and workspace setup for admins.
- [General](https://docs.hailer.com/help/english/general/index.md)
- [BUILT ON HAILER - BADGE KIT](https://docs.hailer.com/help/english/general/built-on-hailer-badge-kit.md)
- [FAQ](https://docs.hailer.com/help/english/general/faq.md)
- [HAILER MCP CONNECTOR](https://docs.hailer.com/help/english/general/hailer-connector-for-claude.md)
- [HAILER PRODUCT DESCRIPTION](https://docs.hailer.com/help/english/general/hailer-product-description.md)
- [Troubleshooting Hailer problems](https://docs.hailer.com/help/english/general/troubleshooting-hailer-problems.md)
- [Using Hailer (all users)](https://docs.hailer.com/help/english/using-hailer-all-users/index.md)
- [Add activities from discussions, calendar and activities views](https://docs.hailer.com/help/english/using-hailer-all-users/activities/add-activities-from-discussions-calendar-and-activities-views.md)
- [How to copy activity in Hailer?](https://docs.hailer.com/help/english/using-hailer-all-users/activities/how-to-copy-activity-in-hailer.md)
- [Show only the most frequently used workflows](https://docs.hailer.com/help/english/using-hailer-all-users/activities/show-only-the-most-frequently-used-workflows.md)
- [Connect your Google Calendar to Hailer Calendar](https://docs.hailer.com/help/english/using-hailer-all-users/calendar/connect-your-google-calendar-to-hailer-calendar.md)
- [How to manage events and activities in Hailer calendar view](https://docs.hailer.com/help/english/using-hailer-all-users/calendar/how-to-manage-events-and-activities-in-hailer-calendar-view.md)
- [Download Hailer desktop application](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/download-hailer-desktop-application.md)
- [Getting started with Hailer](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/getting-started-with-hailer.md)
- [Glossary](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/glossary.md)
- [How to navigate in Hailer?](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/how-to-navigate-in-hailer.md)
- [How to search activities, messages, etc.?](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/how-to-search-activities-messages-etc.md)
- [How to switch themes?](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/how-to-switch-themes.md)
- [Manage Hailer notifications](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/manage-hailer-notifications.md)
- [User Profile Settings](https://docs.hailer.com/help/english/using-hailer-all-users/getting-started/user-profile-settings.md)
- [help/english/using-hailer-all-users/hailer-discussions/hailer-discussions-essentials](https://docs.hailer.com/help/english/using-hailer-all-users/hailer-discussions/hailer-discussions-essentials.md)
- [Introduction into Hailer Discussions](https://docs.hailer.com/help/english/using-hailer-all-users/hailer-discussions/introduction-into-hailer-discussions.md)
- [Workspace setup admin](https://docs.hailer.com/help/english/workspace-setup-admin/index.md)
- [Frequently used functions](https://docs.hailer.com/help/english/workspace-setup-admin/function-fields/frequently-used-functions.md)
- [How to configure Function Fields](https://docs.hailer.com/help/english/workspace-setup-admin/function-fields/how-to-configure-function-fields.md)
- [How to get the start and end date from a date range](https://docs.hailer.com/help/english/workspace-setup-admin/function-fields/how-to-get-the-start-and-end-date-from-a-date-range.md)
- [How to use Function Fields to build a price calculator in Hailer](https://docs.hailer.com/help/english/workspace-setup-admin/function-fields/how-to-use-function-fields-to-build-a-price-calculator-in-hailer.md)
- [Introduction to Function Fields](https://docs.hailer.com/help/english/workspace-setup-admin/function-fields/introduction-to-function-fields.md)
- [Hailer Workspace Settings](https://docs.hailer.com/help/english/workspace-setup-admin/hailer-workspace-settings.md)
- [How to enable public Workspace copy?](https://docs.hailer.com/help/english/workspace-setup-admin/how-to-enable-public-workspace-copy.md)
- [How to import and export data to Hailer?](https://docs.hailer.com/help/english/workspace-setup-admin/how-to-import-and-export-data-to-hailer.md)
- [Create a Hailer web form](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/create-a-hailer-web-form.md)
- [Data modelling in Hailer](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/data-modelling-in-hailer.md)
- [Hailer Bird's Eye View](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/hailer-bird_s-eye-view.md)
- [Hailer Bird's Eye View](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/hailer-birds-eye-view.md)
- [Hailer Workflow settings](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/hailer-workflow-settings.md)
- [How to copy process or workflow module in Hailer?](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/how-to-copy-process-or-workflow-module-in-hailer.md)
- [How to create a custom workflow or process in Hailer?](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/how-to-create-a-custom-workflow-or-process-in-hailer.md)
- [How to set up an email notifier using webhooks and Zapier](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/how-to-set-up-an-email-notifier-using-webhooks-and-zapier.md)
- [What are activity links](https://docs.hailer.com/help/english/workspace-setup-admin/manage-workflows-and-datasets/what-are-activity-links.md)
- [Getting started with prebuild inventory management workflows](https://docs.hailer.com/help/english/workspace-setup-admin/templates/getting-started-with-prebuild-inventory-management-workflows.md)
- [How to add a simple automation to your Hailer workspace with Zapier](https://docs.hailer.com/help/english/workspace-setup-admin/templates/how-to-add-a-simple-automation-to-your-hailer-workspace-with-zapier.md)
- [Prebuilt CRM workflow template](https://docs.hailer.com/help/english/workspace-setup-admin/templates/prebuilt-crm-workflow-template.md)
- [Manage your projects or tasks in Hailer activities timeline](https://docs.hailer.com/help/english/workspace-setup-admin/timeline-view/manage-your-projects-or-tasks-in-hailer-activities-timeline.md)
- [Tips & Tricks for workspace owners and admins](https://docs.hailer.com/help/english/workspace-setup-admin/tips-and-tricks-for-workspace-owners-and-admins.md)
- [Advanced permissions and access control](https://docs.hailer.com/help/english/workspace-setup-admin/user-permissions-and-management/advanced-permissions-and-access-control.md)
- [Guest users](https://docs.hailer.com/help/english/workspace-setup-admin/user-permissions-and-management/guest-users.md)
- [Hailer user permissions](https://docs.hailer.com/help/english/workspace-setup-admin/user-permissions-and-management/hailer-user-permissions.md)
- [Workspace admin best practices](https://docs.hailer.com/help/english/workspace-setup-admin/workspace-admin-best-practices.md)
- [Suomeksi](https://docs.hailer.com/help/finnish/index.md): Hailerin ohjeet suomeksi - aloitus, keskustelut, palvelukuvaus ja tuotekuvaus.
- [Hailer termit tutuksi](https://docs.hailer.com/help/finnish/aloita-hailerin-kaytto/hailer-termit-tutuksi.md)
- [Miten aloitan Hailerin käytön?](https://docs.hailer.com/help/finnish/aloita-hailerin-kaytto/miten-aloitan-hailerin-kayton.md)
- [Profiiliasetukset](https://docs.hailer.com/help/finnish/aloita-hailerin-kaytto/profiiliasetukset.md)
- [Hailer keskustelut - perusteet](https://docs.hailer.com/help/finnish/hailer-keskustelut/hailer-keskustelut-perusteet.md)
- [FI HAILER PALVELUKUVAUS](https://docs.hailer.com/help/finnish/hailer-palvelukuvaus.md)
- [FI HAILER TUOTEKUVAUS](https://docs.hailer.com/help/finnish/hailer-tuotekuvaus.md)
- [Hailer SDK](https://docs.hailer.com/sdk/index.md): CLI toolkit for Hailer workspace development — scaffold projects, manage workspace configuration as code, and generate TypeScript types.
- [hailer-sdk generate](https://docs.hailer.com/sdk/commands/generate.md): Generate TypeScript enums and types from your Hailer workspace.
- [hailer-sdk init](https://docs.hailer.com/sdk/commands/init.md): Initialize a new Hailer project with structure, authentication, and optional MCP server setup.
- [hailer-sdk ws-config](https://docs.hailer.com/sdk/commands/workspace-config.md): Pull and push workspace configuration — workflows, fields, phases, templates, teams, groups, insights, and apps — between Hailer and your local repository.
- [Configuration reference](https://docs.hailer.com/sdk/configuration/index.md): The workspace/ directory — every editable file, the sync/snapshot model, and how create, update, and delete are decided on push.
- [Apps](https://docs.hailer.com/sdk/configuration/apps.md): Configure workspace apps in apps.ts — name, description, URL, generated icon, and members.
- [Fields](https://docs.hailer.com/sdk/configuration/fields.md): Configure a workflow's fields in fields.ts — every field type, shared properties, function fields, reminders, and field modifiers.
- [Groups](https://docs.hailer.com/sdk/configuration/groups.md): Configure workspace groups in groups.ts — hierarchical membership of users, teams, and other groups.
- [Insights](https://docs.hailer.com/sdk/configuration/insights.md): Configure workspace insights in insights.ts — SQL-like reports over workflow data, their sources, query, members, and visibility.
- [Phases](https://docs.hailer.com/sdk/configuration/phases.md): Configure a workflow's phases in phases.ts — order, transitions, colors, phase fields, announcements, and webhooks.
- [Teams](https://docs.hailer.com/sdk/configuration/teams.md): Configure workspace teams in teams.ts — name, description, visibility, default view, and members.
- [Document templates](https://docs.hailer.com/sdk/configuration/templates.md): Configure a workflow's document templates — the templates.ts registry, per-template config (field mappings + options), and the PDF/CSV generation code.
- [Workflows](https://docs.hailer.com/sdk/configuration/workflows.md): Configure workflows — the workflows.ts registry that creates and deletes workflows, and each workflow's main.ts settings.
- [Hailer Studio](https://docs.hailer.com/studio/index.md): AI-assisted development environment for building Hailer workspaces and applications — describe what you need and Studio builds it in an isolated cloud workspace.
- [Session API](https://docs.hailer.com/studio/session-api.md): Create Hailer Studio sessions programmatically over HTTP — including one-shot sessions that start building from an initial prompt.