curl --request GET \
--url https://core.nextmatter.com/api/processes/{id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/processes/{id}/"
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/{id}/', 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/{id}/",
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/{id}/"
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/{id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/processes/{id}/")
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{
"url": "<string>",
"id": 123,
"name": "<string>",
"description": "<string>",
"folder": {
"id": 123,
"name": "<string>"
},
"visibility": {
"mode": "<string>"
}
}Get workflow
Get the details of a workflow, including the published instance-visibility mode.
curl --request GET \
--url https://core.nextmatter.com/api/processes/{id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/processes/{id}/"
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/{id}/', 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/{id}/",
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/{id}/"
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/{id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/processes/{id}/")
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{
"url": "<string>",
"id": 123,
"name": "<string>",
"description": "<string>",
"folder": {
"id": 123,
"name": "<string>"
},
"visibility": {
"mode": "<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
A unique integer value identifying this Process.
Response
The workflow resource URI
The name of the process
The description of the process
The folder of the workflow
Show child attributes
Show child attributes
Instance-visibility settings of the published workflow. Null until the workflow is published. Draft edits are not included; starting an instance uses this published snapshot.
Show child attributes
Show child attributes
Was this page helpful?

