List workflows

Show all workflows that are visible to the user that the API-Key is associated with.

GET /processes

List workflows

cURL

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

200

[
  {
    "folder": {
      "id": 123,
      "name": "<string>"
    },
    "url": "<string>",
    "id": 123,
    "name": "<string>",
    "description": "<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

Response

200 - application/json

folder · object · required

The folder of the workflow

Show child attributes

url · string<uri> · read-only

The workflow resource URI

id · integer · read-only

name · string · read-only

The name of the process

Minimum string length: 1

description · string | null · read-only

The description of the process

Minimum string length: 1