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>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "public_url": "<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

​
aborted_time_after
string<date-time>
​
aborted_time_before
string<date-time>
​
active_step_id
string
​
completed_time_after
string<date-time>
​
completed_time_before
string<date-time>
​
deadline_after
string<date-time>
​
deadline_before
string<date-time>
​
ended_time_after
string<date-time>
​
ended_time_before
string<date-time>
​
last_updated_time_after
string<date-time>
​
last_updated_time_before
string<date-time>
​
lead_user
integer
​
name
string
​
ordering
enum<string>[]

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)
​
organization
integer
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
priority
enum<string> | null
  • V - Very high
  • H - High
Available options:
H,
V
​
process
integer
​
progress_max
integer
Required range: 0 <= x <= 100
​
progress_min
integer
Required range: 0 <= x <= 100
​
query
string
​
started_time_after
string<date-time>
​
started_time_before
string<date-time>
​
status
enum<string>[]
  • running - Running
  • completed - Completed
  • aborted - Aborted
​
step_deadline_after
string<date-time>
​
step_deadline_before
string<date-time>
​
tags
string[]

Multiple values may be separated by commas.

​
total_runtime_max
string<duration>
​
total_runtime_min
string<duration>

Response

200 - application/json; version=v1

The response is of type object.