Skip to content

Get process

Endpoint

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

This endpoint retrieves the full details for a single process instance (run) identified by its unique ID.

Request

Replace {org_id} with your Organization ID and {run_id} with the specific ID of the process run you want to retrieve.

Headers

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

Query parameters (optional)

  • with (string): A comma-separated list to include related data (e.g., checklist, tasks, tags, assets, next_task, tasks.step, tasks.threads, form_fields, ko_form_fields).
  • form_fields_values (boolean, e.g., true): Include the values submitted to form fields.

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const runId = 'PROCESS_RUN_ID_TO_GET';
const queryParams = '?with=checklist,tasks,tags,form_fields&form_fields_values=true'; // Example: get related data and field values
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/runs/${runId}${queryParams}`;
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 => { // Attempt to parse JSON regardless of status
if (!response.ok) {
console.error(`Failed to get process ${runId}:`, data);
throw new Error(`HTTP error! status: ${response.status}`);
}
return data; // Pass successful data along
});
})
.then(data => {
console.log(`Successfully retrieved process ${runId}:`);
console.log(JSON.stringify(data, null, 2));
})
.catch(error => {
console.error(`Error getting process ${runId}:`, error.message);
});

Response

A successful request returns a 200 OK status code and a JSON object containing a data field with the process run’s details.

{
"data": {
"id": "PROCESS_RUN_ID_TO_GET",
"increment_id": 5015,
"checklist_id": "template_id_abc",
"checklist_title": "Client Onboarding V3",
"name": "Onboarding - Globex Corp",
"summary": "New client onboarding process run.",
"status": "active",
"progress": { ... },
"started_by": 1002,
"owner_id": 1002,
"created_at": "2024-05-20T11:00:00Z",
"last_updated": "2024-05-21T09:30:00Z",
"prerun": { // Kick-off form field values if filled
"kickoff_field_id_1": "Globex Corporation",
"kickoff_field_id_2": "2024-06-01T00:00:00Z"
},
// Included if requested with 'with=checklist'
"checklist": { ... template details ... },
// Included if requested with 'with=tasks'
"tasks": [ { ... task details ... } ],
// Included if requested with 'with=tags'
"tags": [ { ... tag details ... } ]
// ... other run properties ...
}
}

If the run ID is not found or you lack permission, a 404 Not Found or 403 Forbidden error will be returned.


Tasks > Get task

A GET endpoint retrieves comprehensive task details including status owners deadlines and form fields through unique organization and task IDs with optional related data parameters.

Processes > List processes

The GET endpoint retrieves and filters process instances within an organization providing paginated results with detailed run information task status and optional related data through various query parameters.

Templates > Get template

An API endpoint that retrieves detailed information about a specific process template using a GET request with optional parameters to include related data such as steps tags and folder hierarchies.

Tasks > List process tasks

The GET endpoint retrieves all tasks linked to a specific process run with customizable filtering options headers and query parameters while supporting multiple programming languages for implementation.