List the instances of a given workflow, optionally filtered.
Use the filters to narrow down the results. Multiple filters can be combined.
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.
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
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)A page number within the paginated result set.
Number of results to return per page.
V
- Very highH
- HighH
, V
0 <= x <= 100
0 <= x <= 100
running
- Runningcompleted
- Completedaborted
- AbortedMultiple values may be separated by commas.
The response is of type object
.