Download OpenAPI specification:Download
Signicat's Mint API allows you to manage and edit your Mint workflows programmatically, facilitating automation and integration with other systems.
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.
If you don't have an account already, sign up for a free Signicat account by completing the following initial preparations:
We recommend you create a sandbox account to test our services before going live. Sandbox and production accounts must be set up separately.
If you require support, you can contact us by creating a support ticket in the Signicat Dashboard.
To authenticate against our APIs, you need to set up an API client. From this step, you will obtain a Client ID and a Client Secret.
To connect to the Mint API you need to configure the correct permissions for you API client.
To grant access to your API client in the Signicat Dashboard:
You are now ready to start connecting to the Mint API!
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.
Learn more about authorisation to the API in the Obtaining an access token documentation.
Retrieves all the flows associated to an account.
| 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" |
Executes a flow by id.
This operation triggers a background flow execution. You can check the execution result using the Instance endpoints.
| id required | string ID of the flow to execute. |
object or null Workflow input. | |
| workflowUrlTtl | integer or null <int32> [ 0 .. 604800 ] The time-to-live for the workflow URL in seconds. Defaults to 60 seconds. |
{- "input": {
- "property1": null,
- "property2": null
}, - "workflowUrlTtl": 604800
}Returns all the instances for a flow, if any available. Additionally, you can filter by instance status.
| definitionId required | string The ID of the flow. |
| 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> |
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.
| 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> |
| id required | string ID of the instance to resume. |
object or null | |
| activityId required | string or null |
{- "input": {
- "property1": null,
- "property2": null
}, - "activityId": "string"
}| id required | string ID of the instance to resume. |
required | object (ResumeApprovalInstanceInputDto) |
| activityId required | string or null |
{- "input": {
- "approved": true,
- "message": "string"
}, - "activityId": "string"
}