Skip to content

List process tasks

Endpoint

GET /organizations/{org_id}/runs/{run_id}/tasks

Returns all tasks for a specific process run.

Request

Replace {org_id} with your Organization ID and {run_id} with the run ID whose tasks you want.

Headers

  • Authorization: Bearer {your_access_token}
  • Accept: application/json
  • X-Tallyfy-Client: APIClient

Query parameters (optional)

  • status (string): Filter by task status - complete, active, active_visible, incomplete, inprogress, not-started, hasproblem, overdue, due_soon. Tasks hidden by rules appear with auto-skipped status in responses but can’t be used as a filter value.
  • owners (string): Comma-separated User IDs.
  • guests (string): Comma-separated Guest emails.
  • groups (string): Comma-separated Group IDs.
  • unassigned (boolean): Filter for unassigned tasks.
  • deadline_start_range / deadline_end_range (string): Filter by deadline range.
  • deadline_on (string): Filter tasks with deadline on an exact date (YYYY-MM-DD). Takes precedence over range filters.
  • deadline_before / deadline_after (string): Filter tasks with deadline before or after a date (YYYY-MM-DD), exclusive.
  • with (string): Include related data - step, threads, comments, assets, form_fields, activities, run, run.checklist, summary. Comma-separate multiple values.
  • page, per_page (integer): Pagination controls. Default per_page is 10.
  • sort (string): Sort by position, deadline (or -position, -deadline for descending).
  • without_pagination (boolean): Set to true to return all results without pagination.

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const runId = 'PROCESS_RUN_ID';
const params = new URLSearchParams({
with: 'step,form_fields',
per_page: '50'
});
const queryStr = params.toString();
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/runs/${runId}/tasks${queryStr ? '?' + queryStr : ''}`;
const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');
fetch(apiUrl, {
method: 'GET',
headers: headers
})
.then(response => {
return response.json().then(data => {
if (!response.ok) {
console.error(`Failed to list tasks for run ${runId}:`, data);
throw new Error(`HTTP error! status: ${response.status}`);
}
return data;
});
})
.then(data => {
console.log(`Tasks for run ${runId}:`);
console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
console.error(`Error listing tasks for run ${runId}:`, error.message);
});

Response

A 200 OK response returns a JSON object with a data array of tasks and a meta object for pagination.

{
"data": [
{
"id": "task_id_1",
"increment_id": 1210,
"title": "Welcome Call",
"run_id": "PROCESS_RUN_ID",
"checklist_id": "template_id",
"step_id": "step_id_welcome",
"alias": "welcome_call",
"status": "active",
"position": 1,
"owners": {
"users": [...],
"guests": [...],
"groups": [...]
},
"deadline": "2025-05-28T17:00:00Z",
"created_at": "2025-05-20T10:00:00Z",
"last_updated": "2025-05-25T14:30:00Z",
"completed_at": null,
"task_type": "task",
"is_oneoff_task": false,
// Included when requesting with=step:
"step": {
"id": "step_id_welcome",
"title": "Schedule Welcome Call"
}
},
{
"id": "task_id_2",
"increment_id": 1211,
"title": "Setup Account",
"run_id": "PROCESS_RUN_ID",
"step_id": "step_id_setup",
"status": "not-started",
"position": 2
}
],
"meta": {
"pagination": { ... }
}
}

Tasks > List organization tasks

Tallyfy’s API lets you retrieve and filter all tasks across an entire organization—including both process-based and one-off tasks—using a GET endpoint with extensive query parameters for status and deadline filtering and owner/guest/group assignment and sorting and pagination with code examples in six languages.

Processes > Get process

Tallyfy’s GET endpoint lets you retrieve full details of a specific process run by its ID and optionally include related data like tasks and form fields and tags through query parameters while also supporting a special “next_task” option that returns the earliest-deadline incomplete task for building dashboards or automating notifications.

Processes > List processes

Tallyfy’s API lets you retrieve a paginated and filterable list of all running process instances in your organization by calling GET on the runs endpoint with optional parameters for status and ownership and tags and sorting and related data inclusion.

Tasks > Get task

Tallyfy’s API lets you fetch any single task by its ID using a GET request and optionally include related data like form fields and process run details through query parameters.