Mint API (v1)
Download OpenAPI specification:Download
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.
To use the Mint API, you must have completed the following initial preparations:
- Sign up to the Signicat Dashboard.
- 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.
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.
To connect to the Mint API you need to configure the correct permissions for you API client.
To grant access to your API client:
- Go to IAM > Permissions in the Signicat Dashboard.
- Search for the name of the API client and, on the same row, click Edit to edit the access rights.
- Click Add next to 'Roles', in the Principal settings menu on the right.
- In the empty Role field at the bottom, click Select to add a new role permission.
- 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.
Get all flows
Retrieves all the flows associated to an account.
Authorizations:
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
- 200
- 401
Execute a flow
Executes a flow by id
.
This operation triggers a background flow execution. You can check the execution result using the Instance endpoints.
Authorizations:
path Parameters
id required | string ID of the flow to execute. |
Request Body schema:
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. |
Responses
Request samples
- Payload
{- "input": {
- "property1": null,
- "property2": null
}, - "workflowUrlTtl": 604800
}
Response samples
- 200
- 400
- 401
- 404
Get all instances by flow ID
Returns all the instances for a flow, if any available. Additionally, you can filter by instance status.
Authorizations:
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
- 200
- 401
- 404
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:
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
- 200
- 401
- 404
Resume a instance by ID
Authorizations:
path Parameters
id required | string ID of the instance to resume. |
Request Body schema: required
object or null | |
activityId required | string or null |
Responses
Request samples
- Payload
{- "input": {
- "property1": null,
- "property2": null
}, - "activityId": "string"
}
Response samples
- 400
- 401
- 404
- 408
Approve a instance by ID
Authorizations:
path Parameters
id required | string ID of the instance to resume. |
Request Body schema: required
required | object (ResumeApprovalInstanceInputDto) |
activityId required | string or null |
Responses
Request samples
- Payload
{- "input": {
- "approved": true,
- "message": "string"
}, - "activityId": "string"
}
Response samples
- 400
- 401
- 404
- 408