curl --request GET \
--url https://core.nextmatter.com/api/processes/{process_id}/instances/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/processes/{process_id}/instances/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://core.nextmatter.com/api/processes/{process_id}/instances/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.nextmatter.com/api/processes/{process_id}/instances/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.nextmatter.com/api/processes/{process_id}/instances/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.nextmatter.com/api/processes/{process_id}/instances/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/processes/{process_id}/instances/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"name": "<string>",
"public_url": "<string>",
"id": 123,
"status": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}List the instances of a given workflow, optionally filtered.
Filtering can be applied using the following query parameters:
name: All instances with the name containing this substringordering: Sorting by ascending or descending options: status, priority, ended_time, total_runtime, started_time. Use-to sort in a descending manner, for example:-statusstatus: Use one of the options:running,completed,abortedprogress: With suffix_minor_maxactive_step_id: Returns all instances of a workflow for which the step with the specified ID hasn’t been completed and is currently activepriority: Use one of the options:V(Very High) orH(High)started_time: With suffix_afteror_beforelast_updated_time: With suffix_afteror_beforedeadline: With suffix_afteror_beforestep_deadline: With suffix_afteror_beforeaborted_time: With suffix_afteror_beforecompleted_time: With suffix_afteror_beforeended_time: With suffix_afteror_beforetotal_runtime_min: Instance duration as%d %H:%M:%S.%for ISO formattotal_runtime_max: Instance duration as%d %H:%M:%S.%for ISO formattags: Name of the tag or tags separated by comma. Multiple tags are searched as OR condition.page: For pagination.
Dates follow the ISO8601 format and UTC standard.
Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of limit and page parameters.
curl --request GET \
--url https://core.nextmatter.com/api/processes/{process_id}/instances/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/processes/{process_id}/instances/"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://core.nextmatter.com/api/processes/{process_id}/instances/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core.nextmatter.com/api/processes/{process_id}/instances/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.nextmatter.com/api/processes/{process_id}/instances/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.nextmatter.com/api/processes/{process_id}/instances/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/processes/{process_id}/instances/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"name": "<string>",
"public_url": "<string>",
"id": 123,
"status": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}Authorizations
Authentication is API key based. As an admin, you can generate an API key in Next Matter by going to Company > Next Matter API keys.
When sending requests to the API, authenticate by passing the API key in the "Authorization" HTTP header, prepended with the string "Api-Key ".
For example:
Authorization: Api-Key xyzabc.12fsfe242ubdgakew
Path Parameters
Query Parameters
organization
process
lead_user
progress
Ordering
name, -name, started_time, -started_time, last_updated_time, -last_updated_time, status, -status, priority, -priority, progress, -progress, deadline, -deadline, ended_time, -ended_time, total_runtime, -total_runtime status
running, completed, aborted name
query
priority
V, H started_time
last_updated_time
deadline
step_deadline
aborted_time
completed_time
ended_time
total_runtime_min
total_runtime_max
active_step_id
tags
A page number within the paginated result set.
Number of results to return per page.
Was this page helpful?

