Skip to main content
GET
/
processes
/
{process_id}
/
instances
/
List workflow instances
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

Authorization
string
header
default:Api-Key YOUR_NM_API_KEY
required

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

process_id
string
required

Query Parameters

organization
string

organization

process
string

process

lead_user
string

lead_user

progress
string

progress

ordering
enum<string>

Ordering

Available options:
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
enum<string>

status

Available options:
running,
completed,
aborted
name
string

name

query
string

query

priority
enum<string>

priority

Available options:
V,
H
started_time
string

started_time

last_updated_time
string

last_updated_time

deadline
string

deadline

step_deadline
string

step_deadline

aborted_time
string

aborted_time

completed_time
string

completed_time

ended_time
string

ended_time

total_runtime_min
string

total_runtime_min

total_runtime_max
string

total_runtime_max

active_step_id
string

active_step_id

tags
string

tags

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Response

200 - application/json
count
integer
required
results
object[]
required
next
string<uri> | null
previous
string<uri> | null