Kissflow APIs enable you to remotely manage (create, read, update and delete) various components within the Kissflow platform including users, groups, workflows, apps, portals and reports.
Kissflow APIs are RESTful web services and you can explore all API endpoints with their complete descriptionhere.
| HTTP method | Description |
|---|---|
| GET | Retrieves data from a resource |
| POST | Creates a new resource or initiates an action |
| PUT | Updates a resource |
| DELETE | Deletes a resource |
HTTP Request Content Type
The Content-Type in the HTTP header specifies the type of data being sent to the server. This tells the server how to interpret the data in the request body. Here are common content types for POST and PUT HTTP requests.
| Content-Type | Description | Usage |
|---|---|---|
| application/json | Indicates that the request body contains JSON (JavaScript Object Notation) data. | Widely used for RESTful APIs as JSON is a lightweight and easily readable format. |
| multipart/form-data | Used for sending files and data in a form. It allows you to upload files along with other data. | Ideal for file uploads or when a mix of files and form data needs to be sent. |
Any of the data formats can be used, provided the correct Content-Type is set in the HTTP request header.
HTTP Response Content Type
In responses, a Content-Type header provides the client with the actual content type of the returned content. Kissflow API responses are in JSON format.
| Content-Type | Description | Usage |
|---|---|---|
| application/json | Indicates that the response body contains JSON data. | Commonly used for RESTful APIs because JSON is lightweight, easily readable, and widely supported across various platforms. |
Base URL
The base URL serves as the foundation for constructing the endpoint URL.
Base URL Structure
The base URL is defined by protocols(schemes), host, and basePath structured as, :///.
- Protocol: HTTP or HTTPS
- Host: Subdomain name and domain name. While subdomain is unique to each Kissflow account, domain name is either kissflow.com or kissflow.eu
- Basepath: Consists of serivice name and API version string
Resource URLs
API requests are constructed using a dynamic base URL followed by the specific resource or collection URL.
Example of a Kissflow API endpoint:
https://demo.kissflow.com/channel/1/{path_params}
Testing APIs
You can test APIs directly from the terminal using the cURL and HTTPie native tester tools. They allow you to send various types of HTTP requests and see the responses directly in your terminal. Follow these steps to execute API calls:
- Under the Authorization tab in the right panel, enter the "Access Key ID" and "Secret Access Key" for HTTP request header authentication.
- In the cURL or HTTPie command line terminal, use the example and edit the HTTP request to the server.
- Click the "Try It" button
Rate Limiting
To maintain a fair distribution of resources among API users and prevent abuse, a limit of 400 API calls per minute can be made.