Details of form field (v2)
curl --request GET \
--url https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_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{
"value": {},
"instance_id": 123,
"instance_name": "<string>",
"settings": {}
}Details of form field (v2)
Retrieve detailed information about a form field, including all instances where the field is used (v2 with cursor pagination).
Performance Tip To avoid performance issues, especially under frequent access, use filters to limit the result set. Uses cursor pagination.
GET
/
v2
/
processes
/
{process_id}
/
steps
/
{step_id}
/
actions
/
{action_id}
/
Details of form field (v2)
curl --request GET \
--url https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_id}/ \
--header 'Authorization: <api-key>'import requests
url = "https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_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/v2/processes/{process_id}/steps/{step_id}/actions/{action_id}/")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.nextmatter.com/api/v2/processes/{process_id}/steps/{step_id}/actions/{action_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{
"value": {},
"instance_id": 123,
"instance_name": "<string>",
"settings": {}
}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
Pattern:
^\d+$Pattern:
^\d+$Pattern:
^\d+$Query Parameters
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)
Available options:
-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 V- Very highH- High
Available options:
H, V Required range:
0 <= x <= 100Required range:
0 <= x <= 100running- Runningcompleted- Completedaborted- Aborted
Available options:
aborted, completed, running Multiple values may be separated by commas.
Response
200 - application/json; version=v1
Was this page helpful?

