Authorizations
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
Body
The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.
255
Time by which the instance should be completed
The priority of the instance. If you don't send this parameter, the priority will be "Regular". Other options are V - "Very High" and H - "High".
V
- Very highH
- High
V
, H
A list of string tags seperated by a comma
Response
The related workflow resource URI
A list of user assignments per step
The instance resource URI. For example https://core.nextmatter.com/api/instances/[instance_id]/.
A snapshot of the workflow structure. If you set "inject_values" query parameter to "true", this will return the input values of the form fields., If you set "steps_time_frame" query parameter to "true", this will return the completion values of the form fields.
List of active step IDs of the instance
List of instance step deadlines
The public URL of the instance (for status tracking), if enabled in the workflow settings
The name of the instance. If automatic naming has been enabled the name parameter needs to be an empty string, null, or completely left out.
255
Time by which the instance should be completed
The priority of the instance. If you don't send this parameter, the priority will be "Regular". Other options are V - "Very High" and H - "High".
V
- Very highH
- High
V
, H
A list of string tags seperated by a comma