GET
/
instances
/
{id}
/
Get instance
curl --request GET \
  --url https://core.nextmatter.com/api/instances/{id}/ \
  --header 'Authorization: <api-key>'
{
  "name": "",
  "process": "<string>",
  "deadline": "2023-11-07T05:31:56Z",
  "priority": "V",
  "tags": [
    "<string>"
  ],
  "step_assignments": [
    {
      "step_id": 123,
      "user_id": 123
    }
  ],
  "url": "<string>",
  "id": 123,
  "started_time": "2023-11-07T05:31:56Z",
  "completed_time": "2023-11-07T05:31:56Z",
  "aborted_time": "2023-11-07T05:31:56Z",
  "last_updated_time": "2023-11-07T05:31:56Z",
  "process_snapshot": "<string>",
  "active_step_ids": [
    123
  ],
  "step_deadlines": "<string>",
  "public_url": "<string>",
  "stage": "<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

​
id
integer
required

A unique integer value identifying this workflow instance.

Query Parameters

​
inject_values
boolean
default:false

Set to "true" to include input values of actions inside the workflow snapshot

​
steps_time_frame
boolean
default:false

Set to "true" to include step completion times inside the workflow snapshot

Response

200 - application/json

The response is of type object.