Open API

How can I integrate with the Tallyfy REST API?

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

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).

Why is the Tallyfy API valuable for custom integrations?

The Tallyfy API becomes essential when you need custom workflow solutions that go beyond our standard interface.

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 (which, let’s be honest, everyone hates), the API brings Tallyfy’s capabilities into the tools your team already uses every day.

This integration approach seriously improves user adoption, boosts productivity, and keeps your data consistent across all your systems.

What capabilities does the Tallyfy API provide?

The API lets you build custom connections, automate complex workflows between Tallyfy and external systems, and extend Tallyfy way beyond what our standard platform offers.

Technical audience

This section contains technical information intended for developers or those collaborating with development teams.

What are the Tallyfy API fundamentals?

Environment	Base URL	Documentation Link
Production	https://go.tallyfy.com/api/	Tallyfy API Reference ↗

How can I authenticate with the Tallyfy API?

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 - no more, no less.
2. Application Token Authentication (Enterprise Plans): 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 (Enterprise Plans): The industry-standard secure way that lets users give your app access to their Tallyfy data without sharing passwords. We recommend this for third-party apps (and your security team will thank you). Learn more.

What headers are required for Tallyfy API requests?

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

X-Tallyfy-Client Header is Mandatory!

Your code must include the X-Tallyfy-Client: APIClient header. Requests without it will fail with a 401. Yes, we’re serious about this one.

What functionality can I access through the Tallyfy API?

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

Functional Category	Available API Operations
Process Management	Launch processes, monitor status, cancel executions
Task Operations	Complete tasks, update form data, manage comments
User Administration	Create/manage users, configure roles & permissions
Template Control	Create/update templates, manage steps & configurations
Data Access	Export process data, retrieve analytics information
File Management	Upload files, manage attachments and documents

How does the Tallyfy API respond to requests?

Tallyfy API responses follow standard conventions:

• All data returns in structured JSON format for easy parsing (no XML nightmares here).
• Standard HTTP status codes indicate request outcomes (200 for success, 4xx/5xx for errors).
• Error responses include detailed, actionable error messages - not cryptic codes that send you down rabbit holes.
• List endpoints support pagination for efficient data retrieval in manageable chunks.

What are the Tallyfy API rate limits?

To keep our platform stable and fair for everyone, Tallyfy has 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

These limits are pretty generous for most use cases. If you’re hitting them regularly, you might want to implement some caching or batching (or reach out to us if you have a legitimate high-volume use case).

How can I get started with the Tallyfy API?

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.

Testing API Calls

Tallyfy doesn’t have a built-in API testing tool (we’re not trying to reinvent Postman). Use standard developer tools like Postman, Insomnia, or command-line curl to experiment with API requests.

The articles below provide more details on specific API uses.

• API clients
• API code samples
• API usage as a third-party application instead of a user
• Combining RPA systems and human operators
• Integrate with Tallyfy using the API
• OAuth authorization flow for third-party applications
• Sniff API calls using Chrome

Recommended next

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

• Learn how to integrate with Tallyfy using the API for detailed authentication and request examples.
• If you’re building a multi-user application, explore API usage as a third-party application to understand client credentials flow.
• Check the API code samples for practical examples in various programming languages.

Related articles

Open Api > Integrate with Tallyfy using the API

The Tallyfy REST API enables workflow integration through user-based or application-based authentication methods while supporting multi-organization contexts and providing webhooks for event-driven functionality.

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.

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

A detailed walkthrough for integrating third-party applications with Tallyfy API using client credentials to make API requests and manage users through secure token-based authentication and authorization flows.

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.