Connectors Reference
Tallyfy is beautiful workflow software that helps you create, track and scale any repeatable process. It helps you eliminate the use of flowcharts, forms and emails by digitizing manual business processes and approval workflows.
|
Status: Preview |
Tier: Premium |
Version: 2.0.0 |
|
Name |
Summary |
|
Get organization's users |
|
|
Get user's organizations |
|
|
Get a member's tasks |
|
|
Invite_User_To_Organization (string org, Invite_User_To_OrganizationParameterBody body) |
Invite a new member to your organization |
|
Create a task |
|
|
Get_Checklists (string org, [Optional]integer version, [Optional]string with) |
Get Blueprints |
|
Launch a Process |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get organization's users
Description: Get all users belonging to an organization
Syntax:
Tallyfy.Get_Organization_Users (string org)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string (Organization) |
Organization Id |
True |
Returns:
Type:Get_Organization_UsersResponse
Summary: Get user's organizations
Description: Get user's organizations
Syntax:
Tallyfy.Get_User_Organizations ()
Returns:
Type:Get_User_OrganizationsResponse
Summary: Get a member's tasks
Description: Get all tasks that belong to a specific member
Syntax:
Tallyfy.Get_User_Tasks (string org, integer user_id, [advanced][Optional]string q, [Optional]string status, [Optional]string sort, [internal][Optional]string with, [advanced][Optional]string tag, [advanced][Optional]integer page, [Optional]integer per_page)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string (Organization) |
Organization Id |
True |
|
|
user_id |
integer (Member) |
Member Id |
True |
|
|
q |
string (Search by Process name) |
Search Tasks by their Process name |
False |
|
|
status |
string (Task status)Values: [hasproblem, overdue, due_soon, active, incomplete, inprogress] |
You can search all Tasks by status |
False |
|
|
sort |
string (Sort by)Values: [deadline, newest, problems] |
Add minus sign (-) before sort value if you want to sort records in descending order. Ex: sort=-improvements |
False |
|
|
with |
string (With)Values: [run, run.checklist, step, threads, comments, assets, run,run.checklist,step,threads,comments,assets] |
Retrieve additional data from Tasks. Separate multiple options with a comma |
False |
|
|
tag |
string (Task tag) |
Search Tasks by Tag name |
False |
|
|
page |
integer (Page number) |
Which results page to retrieve. Default is 1 |
False |
|
|
per_page |
integer (Tasks per page) |
How many Tasks per page. Default is 10 |
False |
Returns:
Summary: Invite a new member to your organization
Description: Invite a new member to your organization
Syntax:
Tallyfy.Invite_User_To_Organization (string org, Invite_User_To_OrganizationParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string (Organization) |
Organization Id |
True |
|
|
body |
Invite_User_To_OrganizationParameterBody
|
|
True |
Returns:
Type:Invite_User_To_OrganizationResponse
Summary: Create a task
Description: Create Task
Syntax:
Tallyfy.Create_Task (string org, Create_TaskParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string (Organization) |
Organization Id |
True |
|
|
body |
|
|
True |
Returns:
Type:Create_TaskResponse
Summary: Get Blueprints
Description: Get Blueprints
Syntax:
Tallyfy.Get_Checklists (string org, [Optional]integer version, [Optional]string with)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string
|
Organization Id |
True |
|
|
version |
integer
|
Specify which Blueprint version to retrieve. (Works only in case of single Blueprint endpoint) |
False |
|
|
with |
string(int10) Values: [runs, runs.collaborators, steps, statistics, runs,statistics,steps,runs.collaborators] |
get relational data, separated by comma |
False |
Returns:
Summary: Launch a Process
Description: Launch a process using a blueprint
Syntax:
Tallyfy.Create_Run (string org, Create_RunParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
org |
string (Organization) |
Organization Id |
True |
|
|
body |
|
|
True |
Returns:
Type:Create_RunResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
Name to give the new Process |
|
checklist_id |
string
|
ID of the Blueprint to start the process from |
|
summary |
string
|
Summary notes to include with the Process |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Unique ID of created Process |
|
checklist_id |
string
|
ID of Blueprint the Process originated from |
|
name |
string
|
Process name |
|
summary |
string
|
Process summary notes |
|
status |
string
|
Process status |
|
progress |
|
progress |
|
started_by |
integer(int32)
|
User id of Process starter |
|
owner_id |
integer(int32)
|
Process owner ID |
|
prerun |
array of (PrerunItem)
|
prerun |
|
starred |
boolean
|
Whether the Process is starred Values: [, ] |
|
created_at |
string(date-time)
|
Date the process was created at |
|
started_at |
string(date-time)
|
Date the Process was started at |
|
last_updated |
string(date-time)
|
Date the Process was last updated |
|
completed_at |
string(date-time)
|
Date process was completed at (if applicable) |
|
archived_at |
string(date-time)
|
Date Process was archived at (if applicable) |
|
due_date_passed |
boolean
|
Whether the Process due date has passed Values: [, ] |
|
collaborators |
array of (integer(int32))
|
collaborators |
|
due_soon |
boolean
|
Whether the process is due soon Values: [, ] |
|
max_task_deadline |
string(date-time)
|
The latest Task deadline |
Summary:
Description: progress
Properties:
|
Name |
Type |
Summary |
|
complete |
integer(int32)
|
How many tasks in the Process have been completed |
|
total |
integer(int32)
|
Total Tasks in the Process |
|
percent |
integer(int32)
|
percentage completion of Process |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Kick Off id (if KO exists) |
|
alias |
string
|
Kick Off alias (if KO exists) |
|
created_at |
string
|
Date Kick Off field was created (if KO exists) |
|
field_type |
string
|
Kick Off field type (if KO exists) |
|
label |
string
|
Kick Off field label (if KO exists) |
|
updated_at |
string(date-time)
|
Date Kick Off field was last updated (if KO exists) |
|
options |
string
|
Kick Off options (if KO exists) |
|
position |
integer(int32)
|
Kick Off position relative to other Kick Off fields (if KO exists) |
|
required |
boolean
|
Whether the Kick Off is required (if KO exists) Values: [, ] |
|
value |
string
|
Value submitted to Kick Off field (if KO exists) |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
owners |
|
owners |
|
task_type |
string
|
Task type Values: [standard, accept_decline] |
|
deadline |
string(date-time)
|
task deadline, in date-time format |
|
description |
string
|
Task's description |
|
name |
string
|
task name |
Summary:
Description: owners
Properties:
|
Name |
Type |
Summary |
|
users |
array of (integer(int32))
|
users |
|
guests |
array of (string)
|
guests |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Unique identifier for the created Task |
|
title |
string
|
Title of the created Task |
|
alias |
string
|
unique alias of the created Task |
|
deadline |
string
|
Deadline of the created Task in date-time format |
|
description |
string
|
Description of the created Task |
|
owner_id |
integer(int32)
|
Unique identifier for the creator of the Task |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
title |
string
|
title |
|
summary |
string
|
summary |
|
starred |
boolean
|
starred |
|
settings |
|
settings |
|
alias |
string
|
alias |
|
prerun |
array of (PrerunItem)
|
prerun |
|
created_by |
integer(int32)
|
created_by |
|
owner_id |
integer(int32)
|
owner_id |
|
started_processes |
integer(int32)
|
started_processes |
|
created_at |
string
|
created_at |
|
last_updated |
string
|
last_updated |
|
archived_at |
string
|
archived_at |
Summary:
Description: settings
Properties:
|
Name |
Type |
Summary |
|
webhook |
string
|
webhook |
|
guidance |
string
|
guidance |
|
guidance_html |
string
|
guidance_html |
|
record_rating |
string
|
record_rating |
|
allow_steps_editing |
string
|
allow_steps_editing |
|
allow_guests_to_track |
string
|
allow_guests_to_track |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
checklist_id |
string
|
checklist_id |
|
alias |
string
|
alias |
|
field_type |
string
|
field_type |
|
guidance |
string
|
guidance |
|
position |
integer(int32)
|
position |
|
required |
boolean
|
required |
|
options |
array of (OptionsItem)
|
options |
|
created_at |
string
|
created_at |
|
last_updated |
string
|
last_updated |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
|
string
|
|
|
username |
string
|
username |
|
first_name |
string
|
first_name |
|
last_name |
string
|
last_name |
|
full_name |
string
|
full_name |
|
profile_pic |
string
|
profile_pic |
|
locale |
string
|
locale |
|
active |
boolean
|
active Values: [, ] |
|
complete |
boolean
|
complete Values: [, ] |
|
is_suspended |
boolean
|
is_suspended Values: [, ] |
|
created_at |
string
|
created_at |
|
last_updated |
string
|
last_updated |
|
last_login_at |
string
|
last_login_at |
|
support_user |
boolean
|
support_user Values: [, ] |
|
phone |
string
|
phone |
|
job_title |
string
|
job_title |
|
job_description |
string
|
job_description |
|
timezone |
string
|
timezone |
|
UTC_offset |
string
|
UTC_offset |
|
last_accessed_at |
string
|
last_accessed_at |
|
approved_at |
string
|
approved_at |
|
disabled_at |
string
|
disabled_at |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
id |
|
name |
string
|
name |
|
description |
string
|
description |
|
address1 |
string
|
address1 |
|
address2 |
string
|
address2 |
|
slug |
string
|
slug |
|
industry |
string
|
industry |
|
welcome_title |
string
|
welcome_title |
|
welcome_description |
string
|
welcome_description |
|
created_on |
string
|
created_on |
|
last_updated |
string
|
last_updated |
|
live_support_enabled |
integer(int32)
|
live_support_enabled |
|
org_logo |
string
|
org_logo |
|
settings |
string
|
settings |
|
country |
string
|
country |
|
state |
string
|
state |
|
city |
string
|
city |
|
zipcode |
string
|
zipcode |
|
users_count |
integer(int32)
|
users_count |
|
payment_state |
string
|
payment_state |
|
team_size |
string
|
team_size |
|
signup_survey |
string
|
signup_survey |
|
user_status |
string
|
user_status |
|
joined_on |
string
|
joined_on |
|
disabled_on |
string
|
disabled_on |
|
last_accessed |
string
|
last_accessed |
|
user_role |
string
|
user_role |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
pagination |
|
pagination |
Summary:
Description: pagination
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
total |
|
count |
integer(int32)
|
count |
|
per_page |
integer(int32)
|
per_page |
|
current_page |
integer(int32)
|
current_page |
|
total_pages |
integer(int32)
|
total_pages |
|
links |
array of (string)
|
links |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DataItem)
|
data |
|
meta |
|
meta |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string
|
Unique identified for the Task |
|
title |
string
|
The title of the Task |
|
run_id |
string
|
Unique identifier for the Task's Process (only for Process Tasks) |
|
step_id |
string
|
step_id |
|
alias |
string
|
Unique alias for the Task (only for Process Tasks) |
|
owners |
|
owners |
|
status |
string
|
Current status of the Task |
|
deadline |
string
|
Deadline of the Task |
|
created_at |
string
|
Date the Task was created |
|
last_updated |
string
|
last_updated |
|
archived_at |
string
|
Date the Task was archived at |
|
completed_at |
string
|
Date the Task was completed |
|
starter_id |
integer(int32)
|
starter_id |
|
completer_id |
integer(int32)
|
ID of the the member who completed the Task |
|
run_status |
string
|
run_status |
Summary:
Description: owners
Properties:
|
Name |
Type |
Summary |
|
users |
array of (integer(int32))
|
users |
|
guests |
array of (string)
|
guests |
Summary:
Description: meta
Properties:
|
Name |
Type |
Summary |
|
overdue_tasks |
integer(int32)
|
Number of overdue Tasks on the current page |
|
tasks_due_soon |
integer(int32)
|
Number of Tasks on the current page that are due soon |
|
pagination |
|
pagination |
Summary:
Description: pagination
Properties:
|
Name |
Type |
Summary |
|
total |
integer(int32)
|
Number of Tasks across all pages |
|
count |
integer(int32)
|
Number of Tasks on the current page |
|
per_page |
integer(int32)
|
per_page |
|
current_page |
integer(int32)
|
current_page |
|
total_pages |
integer(int32)
|
total_pages |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
first_name |
string
|
Invitee's first name |
|
last_name |
string
|
invitee's last name |
|
|
string
|
invitee's work email address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
|
data |
Summary:
Description: data
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Member's unique ID |
|
|
string
|
Member's email |
|
username |
string
|
Member's username |
|
first_name |
string
|
Member's first name |
|
last_name |
string
|
Member's last name |
|
full_name |
string
|
Member's first and last name |
|
profile_pic |
string
|
profile_pic |
|
locale |
string
|
locale |
|
active |
boolean
|
active Values: [, ] |
|
complete |
boolean
|
complete Values: [, ] |
|
is_suspended |
boolean
|
is_suspended Values: [, ] |
|
created_at |
string
|
created_at |
|
last_updated |
string
|
last_updated |
|
last_login_at |
string
|
last_login_at |
|
support_user |
boolean
|
support_user Values: [, ] |
|
country |
|
country |
|
phone |
string
|
phone |
|
job_title |
string
|
job_title |
|
job_description |
string
|
job_description |
|
timezone |
string
|
timezone |
|
UTC_offset |
string
|
UTC_offset |
|
last_accessed_at |
string
|
last_accessed_at |
|
approved_at |
string
|
approved_at |
|
disabled_at |
string
|
disabled_at |
|
status |
string
|
status |
Summary:
Description: country
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
Country id |
|
name |
string
|
name |
|
phone_code |
string
|
phone_code |
|
iso2 |
string
|
iso2 |