Skip to main content
API docs by Redocly

Mint API (v1)

Download OpenAPI specification:Download

Introduction

Signicat's Mint API allows you to manage and edit your flows.

The Mint API is a RESTful API that uses the OAuth 2.0 protocol for authorisation. All request and response bodies are formatted in JSON.

This API reference provides information on available endpoints and how to interact with them. To learn more about the no-code platform Mint, visit the Signicat Mint documentation.

Get started

Initial preparations

To use the Mint API, you must have completed the following initial preparations:

  1. Sign up to the Signicat Dashboard.
  2. In the Signicat Dashboard, set up an organisation, an account and a domain.
    You can find out how to do this in our Initial setup instructions.

If you require support, you can contact us at support@signicat.com.

Get client credentials

To access the Mint API, you need to create an API client and a client secret. You can find out how to do this in our guide on Accessing Signicat API products.

We recommend that you create one API client per API product, but this can depend on your use case or configuration.

Permissions

To connect to the Mint API you need to configure the correct permissions for you API client.

To grant access to your API client:

  1. Go to IAM > Permissions in the Signicat Dashboard.
  2. Search for the name of the API client and, on the same row, click Edit to edit the access rights.
  3. Click Add next to 'Roles', in the Principal settings menu on the right.
  4. In the empty Role field at the bottom, click Select to add a new role permission.
  5. Search and select Flow Editor and Flow Viewer from the 'All available' roles tab.

You are now all set to use the Mint API!

Learn more about authorisation to the API in the Obtaining an access token documentation.

Flow

Get all flows

Retrieves all the flows associated to an account.

Authorizations:
Bearer
query Parameters
IsLatest
boolean
IsLatestOrPublished
boolean
IsPublished
boolean
IsDraft
boolean
AllVersions
boolean
Version
integer <int32>
searchTerm
string
offset
integer <int32>
limit
integer <int32>
orderBy
string (FlowDefinitionOrderByDto)
Enum: "Name" "Description" "CreatedAt"
sortBy
string (SortByDto)
Enum: "Ascending" "Descending"

Responses

Response samples

Content type
No sample

Create a flow

Creates a Mint flow. A flow consists of a series of steps.

Once a flow is successfully created, a unique ID (definitionId) is generated. You can use this definitionId to refer to the flow in all subsequent Mint operations.

Authorizations:
Bearer
Request Body schema:

Definition of the flow to create:

title
string or null
description
string or null
Array of objects or null (StepDto)
object or null
Array of objects or null (ConnectionDto)
tags
Array of strings or null
object or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "steps": [
    ],
  • "customAttributes": {
    },
  • "connections": [
    ],
  • "tags": [
    ],
  • "variables": {
    }
}

Response samples

Content type
No sample

Get a flow by ID

Retrieves a flow object for a given flow ID (definitionId).

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow.

Responses

Response samples

Content type
No sample

Update a flow

Updates an existing flow.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to update.

Request Body schema:

Definition of the flow to update:

title
string or null
description
string or null
Array of objects or null (StepDto)
object or null
Array of objects or null (ConnectionDto)
tags
Array of strings or null
object or null

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "steps": [
    ],
  • "customAttributes": {
    },
  • "connections": [
    ],
  • "tags": [
    ],
  • "variables": {
    }
}

Response samples

Content type
No sample

Delete a flow

Deletes an existing flow. Once a flow is deleted, it can no longer be used.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to delete.

Responses

Response samples

Content type
No sample

Publish a flow

Publishes a flow. Once you publish a flow, a URL link is generated and associated with the flow. You can find the URL in the Mint Dashboard.

If a flow requires end-user interaction, you can share the link with the end-user to invite them to complete the flow online.

To programmatically trigger a flow in the background (without requiring end-user interaction), use the "Execute a flow" endpoint.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to publish.

Responses

Response samples

Content type
No sample

Unpublish a flow

Undo the publishing a flow.

This operation removes the invitation link from a flow you previously published. End-users can no longer access the flow to follow a user journey.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to unpublish.

Responses

Response samples

Content type
No sample

Execute a flow

Executes a flow by definitionId.

This operation triggers a background flow execution. You can check the execution result using the Instance endpoints.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to execute.

Request Body schema:
object or null
workflowUrlTtl
integer or null <int32>

Responses

Request samples

Content type
{
  • "input": {
    },
  • "workflowUrlTtl": 0
}

Response samples

Content type
No sample

Get list of step types

This endpoints provides information about which steps are available when creating or editing a Mint flow.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Get schema of step type

Returns the JSON schema for a step type.

Authorizations:
Bearer
path Parameters
stepType
required
string

The name of the step type.

Responses

Response samples

Content type
No sample

Upload a File

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to publish.

query Parameters
filename
string

Name of the file

Category
string (FileCategory)
Enum: "Generic" "Template" "Sign" "Journey"

Responses

Response samples

Content type
No sample

Download a File

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to publish.

referenceId
required
string

Unique reference of the file

Responses

Response samples

Content type
No sample

Delete a flow

Deletes an existing flow. Once a flow is deleted, it can no longer be used.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow to delete.

referenceId
required
string

Unique reference of the file

Responses

Response samples

Content type
No sample

All Files from Form

Authorizations:
Bearer
path Parameters
formId
required
string <uuid>
submissionId
required
string <uuid>

Responses

Response samples

Content type
No sample

One File from Form

Authorizations:
Bearer
path Parameters
formId
required
string <uuid>
submissionId
required
string <uuid>
inputId
required
string
filename
required
string

Responses

Response samples

Content type
No sample

Get Signing Order Status

Retrieves the status of a signing order.

Authorizations:
Bearer
path Parameters
documentId
required
string <uuid>

Id of the document.

Responses

Response samples

Content type
No sample

Get Signed File

Retrieves the signed file

Authorizations:
Bearer
path Parameters
documentId
required
string <uuid>

Id of the document.

attachmentId
required
string <uuid>

Responses

Response samples

Content type
No sample

Instance

Get all instances by flow ID

Returns all the instances for a flow, if any available. Additionally, you can filter by instance status.

Authorizations:
Bearer
path Parameters
definitionId
required
string

The ID of the flow.

query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderby
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Return a PDF with all instances by flow ID

Downloads a PDF report with information about all the instances of a specific flow.

Authorizations:
Bearer
path Parameters
definitionId
required
string

The ID of the flow.

query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderby
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Returns a CSV with all instances by flow ID

Downloads a CSV file with information about all the instances of a specific flow.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow.

query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderBy
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Returns a CSV with all instances by flow ID

Downloads a CSV file with information about all the instances of a specific flow.

Authorizations:
Bearer
path Parameters
definitionId
required
string

ID of the flow.

query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderBy
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Get all instances

Lists all instances for all flows belonging to a Signicat account.

An Instance provides a log of what happened when a workflow was executed, it contains information about errors or which steps were completed successfully.

Additionally, you can filter by instance status.

Authorizations:
Bearer
query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderby
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Return a PDF with all instances

Downloads a PDF report with information about all the instances for all flows belonging to a Signicat account.

Additionally, you can filter by instance status.

Authorizations:
Bearer
query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderby
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Return a CSV with all instances

Downloads a CSV file with information about all the instances for all flows belonging to a Signicat account.

Additionally, you can filter by user ID and instance status.

Authorizations:
Bearer
query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderBy
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Return a CSV with all instances

Downloads a CSV file with information about all the instances for all flows belonging to a Signicat account.

Additionally, you can filter by user ID and instance status.

Authorizations:
Bearer
query Parameters
status
string (FlowStatus)
Enum: "Idle" "Running" "Finished" "Suspended" "Faulted" "Cancelled"
correlationId
string
orderBy
string (InstanceOrderByDto)
Enum: "Started" "LastExecuted" "Finished"
searchTerm
string
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
No sample

Get instance by ID

Retrieves an instance for a given instanceId.

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

Responses

Response samples

Content type
No sample

Get execution log by instance ID

Retrieves the execution log of an instance for a given instanceId.

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

Responses

Response samples

Content type
No sample

Return a PDF report by instance ID

Downloads a PDF report with information about the outcome results for a specific instance.

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance

Responses

Response samples

Content type
No sample

Return a CSV report by instance ID

Downloads a CSV file with information about the outcome results for a specific instance.

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance.

Responses

Response samples

Content type
No sample

Return a CSV report by instance ID

Downloads a CSV file with information about the outcome results for a specific instance.

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance.

Responses

Response samples

Content type
No sample

Associate an instance to a user

Associates an instance by ID to a user registered in the Signicat Dashboard.

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance.

userId
required
string

ID of the Signicat user to associate.

Responses

Response samples

Content type
No sample

Disassociate an instance from a user

Disassociates an instance by ID to a user registered in the Signicat Dashboard.

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance.

userId
required
string

ID of the Signicat user to disassociate.

Responses

Response samples

Content type
No sample

Download a instance file

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance

referenceId
required
string

Unique reference of the file.

Responses

Response samples

Content type
No sample

Download a zip file containing all the instance files

Authorizations:
Bearer
path Parameters
instanceId
required
string

ID of the instance

Responses

Response samples

Content type
No sample

InstanceNotes

Creates a note for an instance

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

Request Body schema:
note
string or null

Responses

Request samples

Content type
{
  • "note": "string"
}

Response samples

Content type
No sample

Creates a note for an instance activity

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

activityId
required
string

The ID of the activity.

Request Body schema:
note
string or null

Responses

Request samples

Content type
{
  • "note": "string"
}

Response samples

Content type
No sample

Updates a instance note

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

noteId
required
string

The ID of the instance note.

Request Body schema:
note
string or null

Responses

Request samples

Content type
{
  • "note": "string"
}

Response samples

Content type
No sample

Deletes a instance note

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

noteId
required
string

The ID of the instance note.

Responses

Response samples

Content type
No sample

Updates a activity note

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

activityId
required
string

The ID of the activity.

noteId
required
string

The ID of the activity note.

Request Body schema:
note
string or null

Responses

Request samples

Content type
{
  • "note": "string"
}

Response samples

Content type
No sample

Deletes a activity note

Authorizations:
Bearer
path Parameters
instanceId
required
string

The ID of the instance.

activityId
required
string

The ID of the activity.

noteId
required
string

The ID of the activity note.

Responses

Response samples

Content type
No sample

Template

Get all templates

Retrieves all available templates.

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Create a template

Creates a new template.

A template is a flow that can be created and saved as a template and re-used to create multiple flows.

Authorizations:
Bearer
Request Body schema:

Template to create.

object (WriteFlowDto)
title
string or null
description
string or null
Array of objects or null (StepDto)
object or null
Array of objects or null (ConnectionDto)
tags
Array of strings or null
object or null

Responses

Request samples

Content type
{
  • "flow": {
    }
}

Response samples

Content type
No sample

Get a template

Gets a template.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

ID of the template

Responses

Response samples

Content type
No sample

Update a template

Updates an existing template.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

ID of the template.

Request Body schema:

Template to update.

object (WriteFlowDto)
accounts
Array of strings or null

Responses

Request samples

Content type
{
  • "flow": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
No sample

Delete a template

Deletes an existing template.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

ID of the template to delete.

Responses

Response samples

Content type
No sample

Associate a template to an account

Associates a template to a Signicat account.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

ID of the template.

accountIdToAssociate
required
string

ID of the account to associate.

Responses

Response samples

Content type
No sample

Disassociate a template from an account

Disassociates a template from a Signicat account.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

ID of the template.

accountIdToDisassociate
required
string

ID of the account to disassociate.

Responses

Response samples

Content type
No sample