Skip to main content
GET
Get workflow

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 Process.

Response

200 - application/json; version=v1
url
string<uri>
required
read-only

The workflow resource URI

id
integer
required
read-only
name
string
required
read-only

The name of the process

description
string | null
required
read-only

The description of the process

folder
object
required

The folder of the workflow

visibility
object | null
required

Instance-visibility settings of the published workflow. Null until the workflow is published. Draft edits are not included; starting an instance uses this published snapshot.