GET
/
processes
/
{id}
/
Get workflow
curl --request GET \
  --url https://core.nextmatter.com/api/processes/{id}/ \
  --header 'Authorization: <api-key>'
{
  "url": "<string>",
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "folder": {
    "id": 123,
    "name": "<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 Process.

Response

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

The workflow resource URI

id
integer
required
name
string
required

The name of the process

description
string | null
required

The description of the process

folder
object
required

The folder of the workflow