curl --request GET \
--url https://core.nextmatter.com/api/v2/processes/{process_id}/instances/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/v2/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/v2/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/v2/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/v2/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/v2/processes/{process_id}/instances/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/v2/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": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"public_url": "<string>"
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}List workflow instances (v2)
List the instances of a given workflow, optionally filtered (v2 with cursor pagination).
Use the filters to narrow down the results. Multiple filters can be combined.
Dates follow the ISO8601 format and UTC standard. Page size is 100 by default, 500 maximum. Uses cursor pagination for better performance.
curl --request GET \
--url https://core.nextmatter.com/api/v2/processes/{process_id}/instances/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/v2/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/v2/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/v2/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/v2/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/v2/processes/{process_id}/instances/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/v2/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": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"public_url": "<string>"
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}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
^\d+$Query Parameters
The pagination cursor value.
Ordering
name- Name-name- Name (descending)started_time- Started time-started_time- Started time (descending)last_updated_time- Last updated time-last_updated_time- Last updated time (descending)status- Status-status- Status (descending)priority- Priority-priority- Priority (descending)progress- Progress-progress- Progress (descending)deadline- Deadline-deadline- Deadline (descending)ended_time- Ended time-ended_time- Ended time (descending)total_runtime- Total runtime-total_runtime- Total runtime (descending)
-deadline, -ended_time, -last_updated_time, -name, -priority, -progress, -started_time, -status, -total_runtime, deadline, ended_time, last_updated_time, name, priority, progress, started_time, status, total_runtime Number of results to return per page
V- Very highH- High
H, V 0 <= x <= 1000 <= x <= 100running- Runningcompleted- Completedaborted- Aborted
aborted, completed, running Multiple values may be separated by commas.
Was this page helpful?

