List workflow instances

curl --request GET \
  --url https://core.nextmatter.com/api/processes/{process_id}/instances/ \
  --header 'Authorization: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "public_url": "<string>"
    }
  ]
}

Instance

List workflow instances

List the instances of a given workflow, optionally filtered.

Filtering can be applied using the following query parameters:

name: All instances with the name containing this substring
ordering: Sorting by ascending or descending options: status, priority, ended_time, total_runtime, started_time. Use - to sort in a descending manner, for example: -status
status: Use one of the options: running, completed, aborted
progress: With suffix _min or _max
active_step_id: Returns all instances of a workflow for which the step with the specified ID hasn’t been completed and is currently active
priority: Use one of the options: V (Very High) or H (High)
started_time: With suffix _after or _before
last_updated_time: With suffix _after or _before
deadline: With suffix _after or _before
step_deadline: With suffix _after or _before
aborted_time: With suffix _after or _before
completed_time: With suffix _after or _before
ended_time: With suffix _after or _before
total_runtime_min: Instance duration as %d %H:%M:%S.%f or ISO format
total_runtime_max: Instance duration as %d %H:%M:%S.%f or ISO format
tags: Name of the tag or tags separated by comma. Multiple tags are searched as OR condition.
page: For pagination.

Dates follow the ISO8601 format and UTC standard.

Page size is 100 by default, 500 maximum. To paginate, follow the standard usage of limit and page parameters.

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": "<string>",
  "previous": "<string>",
  "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

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

Response

200 - application/json

The response is of type object.

Complete step List workflows

Next Matter API

Endpoints

Authorizations

Path Parameters

Query Parameters

Response