GET
/
processes
/
{process_id}
/
steps
/
{step_id}
/
actions
/
{action_id}
/
Details of form field
curl --request GET \
  --url https://core.nextmatter.com/api/processes/{process_id}/steps/{step_id}/actions/{action_id}/ \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "value": {},
      "instance_id": 123,
      "instance_name": "<string>",
      "settings": {}
    }
  ]
}

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
​
step_id
string
required
​
action_id
string
required

Query Parameters

​
organization
string

organization

​
process
string

process

​
lead_user
string

lead_user

​
progress
string

progress

​
id
string

id

​
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

​
instance_ids
string

instance_ids

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Response

200 - application/json

The response is of type object.