Skip to content
Tallyfy

Getting started with Postman API testing

Set up authentication with your Tallyfy credentials in Postman, then start testing endpoints for templates, processes, and tasks. No code required.

Why use Postman with Tallyfy?

Postman lets you test Tallyfy’s API without writing code. You can:

  • Launch processes from templates
  • Complete tasks and update statuses
  • Export workflow data
  • Test integrations before building them

Think of it as a playground for Tallyfy’s API - you’ll figure out what’s possible before committing to code.

Prerequisites

You’ll need:

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

Quick setup

  1. Get your credentials from Tallyfy

    Go to Settings > Integrations > REST API and copy your:

    • Client ID
    • Client Secret
    • Organization ID
    • Your Tallyfy login email and password

  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_USERNAME = your@email.com
    TALLYFY_PASSWORD = [your password]
    TALLYFY_BASE_URL = https://go.tallyfy.com/api

  3. Set up authentication

    Tallyfy uses the password grant type - most endpoints need user context. Create a new request:

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

  4. Test your first API call

    After getting your access token, try listing templates. Every request needs these headers:

    • Authorization: Bearer [your access token]
    • X-Tallyfy-Client: APIClient
    • Accept: application/json

    Then send:

    • Method: GET
    • URL: {{TALLYFY_BASE_URL}}/organizations/{{TALLYFY_ORG_ID}}/checklists

Important - The API uses different names than the Tallyfy UI. Templates are called checklists and processes are called runs in API endpoints.

Common Tallyfy API operations

Here are the most-used endpoints. All paths sit under /organizations/{{TALLYFY_ORG_ID}}.

Launch a process from a template

POST /organizations/{{TALLYFY_ORG_ID}}/runs
Body: { "checklist_id": "{{TEMPLATE_ID}}", "name": "My Process" }

Complete a task

POST /organizations/{{TALLYFY_ORG_ID}}/runs/{{RUN_ID}}/completed-tasks
Body: { "task_id": "{{TASK_ID}}" }

List active processes

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

Upload a file

POST /organizations/{{TALLYFY_ORG_ID}}/upload

What’s in this guide?

The Postman guide is split into focused sections:

Postman > Authentication setup for Postman

Set up Tallyfy API authentication in Postman using the password grant type with environment variables, the required X-Tallyfy-Client header, and automatic token refresh for uninterrupted API testing.

Open Api > API clients

Tallyfy’s REST API works with any HTTP client - use tools like Postman to test endpoints, explore the API interactively, and debug authentication issues before writing integration code.

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.

Integrations > Open API

Tallyfy’s REST API gives developers full programmatic access to every core platform feature—including process management and task operations and user control and data export—using standard JSON responses and three authentication methods (user tokens and application tokens and OAuth) with required headers sent to a single production endpoint.
Get in touch
About Tallyfy