Kissflow APIs enable you to remotely manage (create, read, update, and delete) various components within the Kissflow platform, including users, groups, workflows, dataforms, datasets, portals, and reports.
\nKissflow APIs are RESTful web services, and this documentation describes all our API endpoints in detail.
\nTo effectively interact with APIs, the following developer requirements are recommended:
\nProgramming knowledge: Basic proficiency in programming languages such as JavaScript, Python, Ruby, Java, or others, depending on the API's technology stack.
\nUnderstanding HTTP and REST principles: Familiarity with HTTP methods (GET, POST, PUT, DELETE) and RESTful principles.
\nJSON data format: Ability to generate, parse, and manipulate JSON data format (JavaScript Object Notation) used for data exchange in APIs.
\nAuthentication and security: Knowledge of authentication methods (e.g., OAuth, API keys, basic authentication) and best practices for securing API endpoints.
\nTools and libraries: Knowledge of tools and libraries for making HTTP requests (e.g., cURL, Postman) and handling API responses.
\nError handling and debugging: Skills in troubleshooting API interactions, handling errors, and debugging issues that may arise during API integration.
\nThese are the fundamental data types and formats used across different API parameters, including header, path, query, and request body parameters.
\nThe base URL serves as the foundation for constructing the endpoint URL.
\nThe base URL is defined by protocols (schemes), host, and basePath and structured as:///.
\nProtocol: HTTP or HTTPS.
\nHost: Subdomain name and domain name. While the subdomain is unique to each Kissflow account, the domain name is kissflow.com or kissflow.eu.
\nBasepath: Consists of the service name and API version string.
\nAPI requests are constructed using a dynamic base URL followed by the specific resource or collection URL.
\nhttps://{subdomain}.kissflow.{region}/{service}/1/{path_params}
You can test APIs directly from the terminal using the cURL and HTTPie native tester tools. They allow you to send various HTTP requests and see the responses directly in your terminal. Follow these steps to execute API calls:
\nUnder the Authorization tab in the right panel, enter the \"Access Key ID\" and \"Secret Access Key\" for HTTP request header authentication.
\nUse the example in the cURL or HTTPie command line terminal and edit the HTTP request to the server.
\nClick the Try It button.
\n\n\n📘 To maintain a fair distribution of resources among API users and prevent abuse, we've set a threshold limit of 400 API calls per minute. This limit includes both programmatic and UI-based invocations.
\n
The Kissflow API enforces a maximum payload size limit of 50 MB per request. Attempts to send payloads larger than this limit will result in an error.
\n\n\nNote: This limit applies to all API endpoints that accept request payloads.
\n
Some requests may be blocked by our security systems before reaching Kissflow services. This can result in intermittent connectivity issues or failed API requests. Learn more.
\nThe Content-Type in the HTTP header specifies the data sent to the server. This tells the server how to interpret the data in the request body. We support the content types for POST and PUT HTTP requests.
\nIn response, a Content-Type header provides the client with the actual content type of the returned content. Kissflow API responses are in JSON format.
\nAccess keys (Access key ID and secret access key) are required to access Kissflow's protected resources. You can follow these instructions to create an Access Key ID and Secret Access Key in your Kissflow account.
\nNote:
\nAccess Key ID and Secret Access Key are generated at the individual user level, not for the entire account.
\nUsers can create multiple access keys within a single account.
\nTo ensure security, users should delete unused access keys.
\nAccess keys are sensitive information that authenticate your identity and should be kept private to prevent misuse.
\n\n\n⚠️ Security alert
\n
Make API calls from the web application server as a best practice. Avoid direct browser calls using JavaScript to prevent exposing API keys. HTTPS/TLS/SSL should be used with basic authentication, as the base64 encoding is reversible and is not secure.
HTTP response status codes indicate whether a specific HTTP request has been completed. Responses are grouped into five classes: Informational responses (100 – 199), successful responses (200 – 299), redirection messages (300 – 399), client error responses (400 – 499), and server error responses (500 – 599).
\nHere are some common response status codes and their description.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started with Kissflow APIs","slug":"getting-started-with-kissflow-apis"},{"content":"API essentials","slug":"api-essentials"},{"content":"Fundamental data types","slug":"fundamental-data-types"},{"content":"Base URL","slug":"base-url"},{"content":"Testing APIs","slug":"testing-apis"},{"content":"HTTP request content type","slug":"http-request-content-type"},{"content":"HTTP response content type","slug":"http-response-content-type"},{"content":"API authentication","slug":"api-authentication"},{"content":"HTTP response status codes","slug":"http-response-status-codes"}],"owner":"37347739","collectionId":"cc642dc6-7519-4766-af30-cdc1f7fbccb1","publishedId":"2sA3rxqtVV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1F80FF"},"publishDate":"2025-06-03T07:12:11.000Z"},"item":[{"name":"Users and groups","item":[{"name":"Users","item":[{"name":"Get user details","id":"b6604282-98bc-4069-81af-725f4f776bbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-Access-Key-Id","value":"(Required) Access key ID
\n","type":"text"},{"key":"X-Access-Key-Secret","value":"(Required) Access key secret
\n","type":"text"}],"url":"https://subdomain.kissflow.com/user/2/:account_id/:user_id","description":"Retrieves the user details of a specific Kissflow user.
\n","urlObject":{"path":["user","2",":account_id",":user_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"(Required) Kissflow Account ID. Learn how to retrieve an Account ID from Kissflow.
\n","type":"text/plain"},"type":"any","value":"(Required) The unique ID of a Kissflow user. Get this value from the '_id' field returned by the 'Get user list' API. This is a mandatory parameter.
\n","type":"text/plain"},"type":"any","value":"(Required) Access key ID
\n","type":"text"},{"key":"X-Access-Key-Secret","value":"(Required) Access key secret
\n","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"_id\": \"Performs bulk user actions like name change, email change, user role change, user deletions etc.
\n","urlObject":{"path":["user","2",":account_id","batch"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"(Required) Kissflow Account ID. Learn how to retrieve an Account ID from Kissflow.
\n","type":"text/plain"},"type":"any","value":"(Required) Access key ID
\n","type":"text"},{"key":"X-Access-Key-Secret","value":"(Required) Access key secret
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"Email\": \"Creates a new user in a Kissflow account.
\n","urlObject":{"path":["user","2",":account_id",""],"host":["https://subdomain.kissflow.com"],"query":[{"description":{"content":"Allows you to send an Email invite to the new user. This is an optional parameter.
\n","type":"text/plain"},"key":"skip_email","value":"(Required) Kissflow Account ID. Learn how to retrieve an Account ID from Kissflow.
\n","type":"text/plain"},"type":"any","value":"