Skip to content
Tallyfy

Getting started with Postman API testing

To test Tallyfy’s API with Postman, set up authentication with your API credentials, then import our collection to explore endpoints for templates, processes, and tasks. This guide walks you through complete setup and provides real examples.

What is Postman and why use it with Tallyfy?

Postman helps you test API endpoints without writing code. For Tallyfy, this means you can quickly:

  • Launch processes programmatically
  • Update task statuses in bulk
  • Export workflow data
  • Test integrations before building them

Think of Postman as your Tallyfy API playground - perfect for exploring what’s possible before committing to code.

Prerequisites

Before starting, you need:

  • A Tallyfy account with API access enabled
  • Postman desktop app or web version (free at postman.com ↗[1])
  • Your Tallyfy API credentials (found in Settings > API)

Quick setup

  1. Get your Tallyfy API credentials

    Navigate to Settings > API in Tallyfy and copy your:

    • Client ID
    • Client Secret
    • Organization ID

  2. Create a Postman environment

    In Postman, click Environments > Create Environment. Add these variables:

    TALLYFY_CLIENT_ID = [your client id]
    TALLYFY_CLIENT_SECRET = [your client secret]
    TALLYFY_ORG_ID = [your organization id]
    TALLYFY_BASE_URL = https://go.tallyfy.com/api

  3. Set up authentication

    Create a new request in Postman:

    • Method: POST
    • URL: {{TALLYFY_BASE_URL}}/oauth/token
    • Body (x-www-form-urlencoded): 
      grant_type = client_credentials
      client_id = {{TALLYFY_CLIENT_ID}}
      client_secret = {{TALLYFY_CLIENT_SECRET}}

  4. Test your first API call

    After getting your access token, try listing templates:

    • Method: GET
    • URL: {{TALLYFY_BASE_URL}}/organizations/{{TALLYFY_ORG_ID}}/templates
    • Authorization: Bearer Token (paste your access token)

Common Tallyfy API operations

Here are the most useful endpoints for workflow automation:

Launch a process from template

POST /organizations/{{TALLYFY_ORG_ID}}/templates/{{TEMPLATE_ID}}/launch

Complete a task

PUT /tasks/{{TASK_ID}}/complete

List all active processes

GET /organizations/{{TALLYFY_ORG_ID}}/processes?status=active

Upload file to task

POST /tasks/{{TASK_ID}}/files

What will I find in this guide?

This complete Postman guide is organized into focused sections:

Open Api > API clients

Tallyfy’s REST API supports popular development tools like Postman to help developers test endpoints interactively explore the API generate code snippets and debug authentication issues with complete guides covering authentication templates processes and advanced integration patterns.

Postman > Authentication setup for Postman

Tallyfy’s API authentication in Postman requires using the password grant type with proper environment variables for credentials and the mandatory X-Tallyfy-Client header on every request while implementing automatic token refresh before the one-hour expiry to maintain uninterrupted API testing access.

Integrations > Open API

The Tallyfy REST API enables developers to build custom integrations with full platform functionality through three authentication methods (user tokens application tokens and OAuth) while providing complete access to process management task operations user administration and data export capabilities with standard JSON responses and reasonable rate limits.

Open Api > API integration guide

The Tallyfy REST API enables workflow automation through two authentication methods (user-based tokens obtained from Settings or application-based OAuth credentials) requiring specific headers and proper token management while supporting multi-organization contexts and webhook integrations with standardized date formats.
Get in touch
About Tallyfy