Skip to content

Open API

Tallyfy REST API overview

The Tallyfy REST API lets developers build custom connections to our core platform features through code-based integrations.

Tallyfy’s “API-first” approach means our public API gives you the exact same functionality that powers our web app - no second-class citizen treatment here. Everything we built for ourselves, you get too. This foundation guarantees stable APIs for your mission-critical integrations (because we depend on them just as much as you do).

Use cases for API integration

API integration lets you embed Tallyfy functionality right into your existing business apps, automate complex workflows across multiple systems, and create completely customized user experiences. Instead of forcing people to context-switch between different systems, the API brings Tallyfy’s capabilities into the tools your team already uses.

API capabilities

The API lets you build custom connections, automate workflows between Tallyfy and external systems, and extend platform functionality.

API fundamentals

EnvironmentBase URLDocumentation Link
Productionhttps://go.tallyfy.com/api/Tallyfy API Reference

Authentication methods

Tallyfy provides three secure authentication methods for programmatic API access:

  1. User Token Authentication: Get a token for specific Tallyfy users (from their profile or through our API). Your app works with that user’s exact permissions and access.
    • Note: Personal access tokens are invalidated when users log out. For stable, long-running automations, consider application tokens instead.
  2. Application Token Authentication: Get app-level credentials (client ID & secret) so your application can act on behalf of multiple users. Perfect for server-to-server connections or multi-user apps.
  3. OAuth Authentication Flow: The industry-standard secure way that lets users give your app access to their Tallyfy data without sharing passwords. Recommended for third-party apps. Learn more.

Required headers

Every API request must include these mandatory headers:

Authorization: Bearer {your_access_token} // Your user or app token
Content-Type: application/json // Tells Tallyfy you're sending JSON data
X-Tallyfy-Client: APIClient // **Required** - Identifies the request source

Available API operations

The API provides comprehensive access to core Tallyfy features, including:

Functional CategoryAvailable API Operations
Process ManagementLaunch processes, monitor status, cancel executions
Task OperationsComplete tasks, update form data, manage comments
User AdministrationCreate/manage users, configure roles & permissions
Template ControlCreate/update templates, manage steps & configurations
Data AccessExport process data, retrieve analytics information
File ManagementUpload files, manage attachments and documents

API response format

Tallyfy API responses follow standard conventions:

  • All data returns in structured JSON format for easy parsing.
  • Standard HTTP status codes indicate request outcomes (200 for success, 4xx/5xx for errors).
  • Error responses include detailed, actionable error messages.
  • List endpoints support pagination for efficient data retrieval.

Rate limits

Tallyfy enforces these rate limits:

  • Per-minute limit: Maximum 100 requests per minute (per organization)
  • Per-hour limit: Maximum 1,000 requests per hour (per organization)
  • Rate limit monitoring: API response headers indicate current usage and remaining capacity

If you’re hitting these limits regularly, implement caching or batching. Contact support for high-volume use cases.

Getting started

  1. Get your API credentials: Find your API keys/tokens at Settings > Integrations > REST API in Tallyfy.
  2. Check out our documentation: Read through the official API docs for detailed info on endpoints and how to use them.
  3. Look at code examples: Check out practical examples on Tallyfy’s GitHub repo for different programming languages.

After understanding the API basics, we recommend these next steps:

Open Api > Integrate with Tallyfy using the API

Tallyfy provides a comprehensive REST API that enables developers to integrate workflow functionality into external applications using two authentication methods - user-based tokens for personal integrations and application-based OAuth credentials for third-party applications - while supporting features like token refresh automatic retry logic and webhook capabilities for event-driven integrations.

Open Api > API usage as a third-party application instead of a user

Third-party applications can integrate with Tallyfy using OAuth 2.0 client credentials flow to embed workflow functionality by obtaining client credentials from Tallyfy support then requesting application tokens to provision users and generate user-specific tokens for making API calls on behalf of users within their organization.

Open Api > API code samples

The Tallyfy REST API documentation provides code samples across multiple programming languages for integrating with the platform using proper authentication headers and base URL endpoints.

Code Samples > Authentication methods

The Tallyfy API requires proper authentication through personal access tokens or OAuth flow along with specific headers to enable secure platform access and custom integrations.