API Reference
Introduction
The SimWorkflow API closely follows REST semantics and uses standard HTTP status codes to indicate the outcome of each operation.
All API responses, including error responses, are returned in JSON format.
API endpoint base URL
https://api.simworkflow.com/
Authentication
Authenticate with the SimWorkflow API by providing one of your personal access tokens in each request. You can manage your personal access tokens from your account.
Personal access tokens carry many privileges, so keep them secure.
Do not share your personal access tokens in publicly accessible areas such as GitHub, client-side code, or other public locations.
Authentication is performed using the HTTP Authorization header with a bearer token.
All API requests must be made over HTTPS. Requests made over plain HTTP will fail. Authentication is required for all API requests.
Example request
curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflow-definitions"
Errors
SimWorkflow uses conventional HTTP response codes to indicate whether an API request succeeded or failed.
In general, status codes in the 2xx range indicate success, status codes in the 4xx range indicate an error caused by the request, and status codes in the 5xx range indicate an error with SimWorkflow's servers.
Example error response body
{
"status": 401,
"error": "Unauthorized",
"message": "Missing authentication token"
}
Error response body fields
|
Field |
Description |
|---|---|
|
|
|
|
|
A short string describing the error that occurred. |
|
|
A human-readable message with more details about the error. |
Rate limits
In general, applications that integrate with SimWorkflow may make no more than a set number of requests per second per user. These limits help maintain service performance and ensure fair usage for all SimWorkflow users.
Rate limiting ensures that calls to the SimWorkflow API do not exceed the maximum allowed request limits.
If you exceed an API rate limit, the API returns an HTTP 429 Too Many Requests error.
The following table shows the rate limits.
|
Plan |
Per-user limit |
Per-organization limit |
|---|---|---|
|
Free |
1 request per user per second |
100 requests per organization per 60 seconds |
|
Team |
5 requests per user per second |
1,000 requests per organization per 60 seconds |
API specification
Workflow definition
- Workflow definition object
- Create a workflow definition
- Get a workflow definition
- Update a workflow definition
- Disable a workflow definition
- Enable a workflow definition
- List workflow definitions
- Get workflow definition variables
- Get a workflow definition variable value
- Add or update a workflow definition variable value
- Delete a workflow definition variable