{"info":{"_postman_id":"9d3cfe2e-d7f2-49c2-8997-d965cbe58bb2","name":"KISSFLOW LEGACY APIs (v 3.0)","description":"

Getting started with Kissflow APIs

Kissflow legacy APIs (v. 3.0) enable you to remotely manage (create, read, update, and delete) various components within the Kissflow platform, including users, groups, processes, projects, datasets, and more.

Kissflow APIs are RESTful web services, and this documentation describes all our API endpoints in detail.

API essentials

To effectively interact with APIs, the following developer requirements are recommended:

Programming knowledge: Basic proficiency in programming languages such as JavaScript, Python, Ruby, Java, or others, depending on the API's technology stack.

Understanding HTTP and REST principles: Familiarity with HTTP methods (GET, POST, PUT, DELETE) and RESTful principles.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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

JSON data format: Ability to generate, parse, and manipulate JSON data format (JavaScript Object Notation) used for data exchange in APIs.

Authentication and security: Knowledge of authentication methods (e.g., OAuth, API keys, basic authentication) and best practices for securing API endpoints.

Tools and libraries: Knowledge of tools and libraries for making HTTP requests (e.g., cURL, Postman) and handling API responses.

Error handling and debugging: Skills in troubleshooting API interactions, handling errors, and debugging issues that may arise during API integration.

Fundamental data types

These are the fundamental data types and formats used across different API parameters, including header, path, query, and request body parameters.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type	Description
String	A sequence of characters with Unicode support
Integer	Signed 64-bit integral number
Boolean	Represents a value of either true or false
Date	A date formatted in ISO 8601 extended format: YYYY-MM-DD
DateTime	Combined date and time formatted in ISO 8601 extended format: YYYY-MM-DDTHH:MM:SS±hh:mm For example, 2018-12-03T10:15:30+01:00 (Europe/Paris)

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 and structured as:///.

Protocol: HTTP or HTTPS.
\n
Host: Subdomain name and domain name. While the subdomain is unique to each Kissflow account, the domain name is kissflow.com.
\n
Basepath: Consists of the service name and API version string.
\n

Resource URLs

API requests are constructed using a dynamic base URL followed by the specific resource or collection URL.

Example API endpoint:

https://{subdomain}.kissflow.{region}/{service}/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 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.
\n
Use the example in the cURL or HTTPie command line terminal and edit the HTTP request to the server.
\n
Click the Try It button.
\n

Rate limiting

\n
📘 To maintain a fair distribution of resources among API users and prevent abuse, a limit of 400 API calls per minute can be made.
\n

HTTP request content type

The 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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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.	It is ideal for file uploads or when a mix of files and form data needs to be sent.

HTTP response content type

In response, a Content-Type header provides the client with the actual content type of the returned content. Kissflow API responses are in JSON format.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Content-Type	Description	Usage
application/json	Indicates that the response body contains JSON data.	It is commonly used for RESTful APIs because JSON is lightweight, easily readable, and widely supported across various platforms.

API authentication

API key (X-Api-Key) is required to access Kissflow's protected resources. You can follow these instructions to create an API key in your Kissflow account.

Note:

API key is generated at the individual user level, not for the entire account.
\n
Users can create multiple API keys within a single account.
\n
To ensure security, users should delete unused API keys.
\n
API keys are sensitive information that authenticate your identity and should be kept private to prevent misuse.
\n

\n
⚠️ Security alert
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.
\n

HTTP response status codes

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).

Here are some common response status codes and their description.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP status codes	Type	Description
200	Success	This status code indicates that the server has successfully processed the request from the client.
201	Created	The request succeeded, and a new resource was created as a result. This is typically the response sent after POST requests or some PUT requests.
400	Bad request	This error indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
401	Unauthorized	This error indicates that the client has attempted to access a resource that requires authentication, but the provided credentials (or lack thereof) are invalid or not accepted by the server. It is often related to authentication issues, such as an incorrect username or password or a missing authentication token.
403	Forbidden	This error indicates that the client has requested a resource they are not authorized to access, even though it exists on the server. It usually means that the server has understood the request but refuses to fulfill it due to permission restrictions or authentication issues.
404	Resource not found	This error indicates that the server cannot find the requested resource. In the browser, this means the URL is not recognized. This can also mean that the endpoint is valid in an API, but the resource does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client.
500	Internal server error	This general error code means something went wrong on the server, but the server could not be more specific about the exact problem. It's a catch-all response for unexpected conditions the server encounters while processing a request. This could be due to server software issues, misconfigured settings, or other internal errors.
501	Not Implemented	This error indicates that the server does not support the request method and cannot be handled. The only methods servers are required to support (and therefore must not return this code) are GET and HEAD.
502	Bad gateway	This error occurs when the server acts as a gateway or proxy and receives an invalid response from the upstream server to which it sent the request. The server receives an invalid response from another server or service it was trying to communicate with.
503	Service Unavailable	This error indicates that the server is not ready to handle the request. Common causes are a server that is down for maintenance or overloaded. This response sends a user-friendly page explaining the problem, and the Retry-After HTTP header would, wherever possible, contain the estimated time before the service is recovered.
504	Gateway timeout	This occurs when the server is acting as a gateway and cannot get a response in time.

","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":"9d3cfe2e-d7f2-49c2-8997-d965cbe58bb2","publishedId":"2sAY4vgMuJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4AA147"},"publishDate":"2024-12-06T12:52:58.000Z"},"item":[{"name":"SETTINGS","item":[{"name":"My Items and My Tasks","item":[{"name":"Get status of created process items","id":"4afb6748-537c-4a06-a1ed-c6a5bf697a8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/search/1/:account_id/global/myitems/:status/p1/:page_size","description":"

This endpoint lets you retrieve a list of process items created by you on a defined page size.

\n","urlObject":{"path":["search","1",":account_id","global","myitems",":status","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"669654e3-64f2-487e-bf1d-a705b436010d","description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"41eb3e17-4758-4c86-a92f-48aadd489352","description":{"content":"

(Required) Current <glossary:Status> of an item in a process. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"status"},{"id":"5ffa1424-a320-41a0-9a1d-35de937274f6","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"page_size"}]}},"response":[{"id":"27a825f6-3869-407f-abf3-427b4727265c","name":"This request successfully retrieves a list of all your intiated, in progress, withdrawn, rejected, or completed flow items.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/search/1/:account_id/global/myitems/:status/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["search","1",":account_id","global","myitems",":status","p1",":page_size"],"variable":[{"key":"account_id"},{"key":"status"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Created at\": \"\",\n \"Flow Id\": \"\",\n \"Flow Name\": \"\",\n \"Item Title\": \"\",\n \"_activity_id\": \"\",\n \"_activity_instance_id\": \"\"\n}"},{"id":"f2cec76d-dd78-460f-96cf-e22176674809","name":"The status of your items could not be retrieved due to insufficient permission.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/search/1/:account_id/global/myitems/:status/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["search","1",":account_id","global","myitems",":status","p1",":page_size"],"variable":[{"key":"account_id"},{"key":"status"},{"key":"page_size"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"4afb6748-537c-4a06-a1ed-c6a5bf697a8c"},{"name":"Get current items assigned to you","id":"427dd28a-a416-43af-9751-cdab1d4ba780","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/search/1/:account_id/global/pendingitems/p1/:page_size","description":"

This endpoint lets you retrieve a list of process items currently assigned to you.

\n","urlObject":{"path":["search","1",":account_id","global","pendingitems","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"f669109c-2736-498a-8ac3-cd81d2f09299","description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"e69dd733-2eb9-44d4-8171-c86bc3724279","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"page_size"}]}},"response":[{"id":"e2b9467f-8b5a-4428-a023-4f25adcc0aa0","name":"This request successfully retrieves a list of items that are assigned to you for approval.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/search/1/:account_id/global/pendingitems/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["search","1",":account_id","global","pendingitems","p1",":page_size"],"variable":[{"key":"account_id"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Created at\": \"\",\n \"Due Date\": \"\",\n \"Flow Id\": \"\",\n \"Flow Name\": \"\",\n \"Item Title\": \"\",\n \"Step Name\": \"\",\n \"_activity_id\": \"\",\n \"_activity_instance_id\": \"\",\n \"_created_by\": {},\n \"_status\": \"\"\n}"},{"id":"01735aef-2097-493d-9d72-9bac1a13d31e","name":"The status of your tasks could not be retrieved due to insufficient permission.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/search/1/:account_id/global/pendingitems/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["search","1",":account_id","global","pendingitems","p1",":page_size"],"variable":[{"key":"account_id"},{"key":"page_size"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"427dd28a-a416-43af-9751-cdab1d4ba780"}],"id":"95788368-cb2e-41ff-9d73-fb00627c68ad","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c7603505-28a8-4193-b593-a4019f2dbd1f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"946b58b8-f76f-4adb-8d59-e35ad7ff5d56","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"95788368-cb2e-41ff-9d73-fb00627c68ad","description":""},{"name":"User","item":[{"name":"Create a new user","id":"6bfa66c2-be15-4052-9f99-c50753fa0c64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"FirstName\": \"\",\n \"Groups\": [\n \"\",\n \"\"\n ],\n \"LastName\": \"\",\n \"Manager\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"NickName\": \"\",\n \"Phone\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/user/1/:account_id/","description":"

This endpoint lets you create a new user in Kissflow.

\n","urlObject":{"path":["user","1",":account_id",""],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"37bdd6b1-b83a-4da5-924f-f3f97ad2b584","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"0de9a7da-7648-476d-a8c3-31ac7ed555f2","name":"This request creates a new user in Kissflow.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"FirstName\": \"\",\n \"Groups\": [\n \"\",\n \"\"\n ],\n \"LastName\": \"\",\n \"Manager\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"NickName\": \"\",\n \"Phone\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Accessibility\": \"\",\n \"AppConfig\": {\n \"ProfileBasePath\": \"\",\n \"UploadHost\": \"\"\n },\n \"DelegatedTo\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"DelegationEndDate\": \"\",\n \"DelegationStartDate\": \"\",\n \"Designation\": \"\",\n \"FirstName\": \"\",\n \"Groups\": [\n \"\",\n \"\"\n ],\n \"Kind\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Manager\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Signature\": \"\",\n \"Status\": \"\",\n \"TimeZone\": {},\n \"UserSystemType\": \"\",\n \"UserType\": \"\",\n \"_created_at\": \"\",\n \"_created_by\": {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": false\n },\n {\n \"_id\": -58175554.30698565\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n },\n \"_modified_at\": \"\",\n \"_modified_by\": {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": -3832481\n },\n {\n \"_id\": \"amet culpa est\"\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n }\n}"},{"id":"00310d48-62a2-4146-9882-95286f87e00f","name":"The request to create a new user could not be processed due to a malformed request syntax. Check if you've entered the first name, phone number, and email in the body parameters fields.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"FirstName\": \"\",\n \"Groups\": [\n \"\",\n \"\"\n ],\n \"LastName\": \"\",\n \"Manager\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"NickName\": \"\",\n \"Phone\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"},{"id":"8ca63216-470a-4d5a-b6d6-18a186e4418a","name":"The request could not be processed as the user is already a part of the account or you don't have sufficient permission to perform this action.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"FirstName\": \"\",\n \"Groups\": [\n \"\",\n \"\"\n ],\n \"LastName\": \"\",\n \"Manager\": {\n \"Kind\": \"\",\n \"Name\": \"\"\n },\n \"NickName\": \"\",\n \"Phone\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"6bfa66c2-be15-4052-9f99-c50753fa0c64"},{"name":"Activate a new user","id":"18a3686c-66e2-4290-978d-0351ae91fb80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/user/1/:account_id/activate","description":"

This endpoint lets you activate a user in Kissflow.

\n","urlObject":{"path":["user","1",":account_id","activate"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"d29e9661-b5a4-4454-9510-0edae1fb54a7","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"06accbfe-9e96-4e9b-93fe-9e0bbe21cf21","name":"This request retrieves a list of activated users in Kissflow.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/activate","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","activate"],"variable":[{"key":"account_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]"},{"id":"c39399e0-3627-43e4-9ff0-41aedc47ad3f","name":"Permission issues","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/activate","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","activate"],"variable":[{"key":"account_id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"18a3686c-66e2-4290-978d-0351ae91fb80"},{"name":"Bulk user actions","id":"0b234d3c-9c6a-4a15-9b07-1f2bce8e6ed2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/user/1/:account_id/batch","description":"

This endpoint lets you perform bulk user actions like name and email change, user permission change, user deletions etc. in Kissflow.

\n","urlObject":{"path":["user","1",":account_id","batch"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"473edca9-d188-4e29-8680-a59809a09ee6","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"239a70ff-6613-4d42-8a3b-0cf91bf99da6","name":"This request performs bulk user actions like user name change, email change, deletion, suspension etc. successfully.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/batch","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","batch"],"variable":[{"key":"account_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]"},{"id":"240d3146-3d7d-4812-87b8-e0a3f1bb5ffe","name":"The request to perform bulk user actions could not be processed as you don't have sufficient permission to do so.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/batch","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","batch"],"variable":[{"key":"account_id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"0b234d3c-9c6a-4a15-9b07-1f2bce8e6ed2"},{"name":"Deactivate user","id":"d0a3e9e3-d91a-416d-8c99-ae75bbcfd5e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/user/1/:account_id/deactivate","description":"

This endpoint lets you deactivate users in Kissflow.

\n","urlObject":{"path":["user","1",":account_id","deactivate"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"12f0478b-fd3b-4a1e-96fe-9ebfe1169173","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"9c82b2d9-4b89-43ab-9fe0-842dfeab3eb8","name":"This request retrieves the list of deactivated users in Kissflow.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/deactivate","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","deactivate"],"variable":[{"key":"account_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n]"},{"id":"3e8905e3-edbe-4a6a-a73e-ec5eb459b763","name":"Request to perform user deactivation could not be processed as you don't have sufficient permission to do so.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"[\n \"\",\n \"\"\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/deactivate","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","deactivate"],"variable":[{"key":"account_id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"d0a3e9e3-d91a-416d-8c99-ae75bbcfd5e2"},{"name":"Get user list","id":"a4a98f1a-70ad-4204-90d5-79ba2cb20408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/user/1/:account_id/p/:size?q=&user_type=User Admin","description":"

This endpoint lets you retrieve all the users in the Kissflow account.

\n","urlObject":{"path":["user","1",":account_id","p",":size"],"host":["https://subdomain.kissflow.com"],"query":[{"description":{"content":"

The search filter string. This is an optional parameter.

\n","type":"text/plain"},"key":"q","value":""},{"description":{"content":"

<<glossary:User Type>> defines the permission of a specific user in Kissflow.

\n","type":"text/plain"},"key":"user_type","value":"User Admin"}],"variable":[{"id":"6d9d3d5b-0a56-48f7-9034-db53a7e4948f","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"0d3aea79-72dd-4ed3-89e0-d4893f1bc82f","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"10","key":"size"}]}},"response":[{"id":"281d10bc-f974-4f19-bb5f-9dc6e189adc3","name":"This request retrieves the list of all users based on the filter set by you.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/p/:size?q=&user_type=User Admin","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id","p",":size"],"query":[{"description":"The search filter string. This is an optional parameter.","key":"q","value":""},{"description":"<> defines the permission of a specific user in Kissflow.","key":"user_type","value":"User Admin"}],"variable":[{"key":"account_id"},{"key":"size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": 58742694\n },\n {\n \"_id\": \"adipisicing\"\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n },\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": \"enim nulla a\"\n },\n {\n \"_id\": 59023578\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n }\n]"}],"_postman_id":"a4a98f1a-70ad-4204-90d5-79ba2cb20408"},{"name":"Get user details","id":"fb5ba026-b803-40cd-9f26-968cfebf8105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/user/1/:account_id/:user_id","description":"

This endpoint lets you retrieve the user details of a specific Kissflow user.

\n","urlObject":{"path":["user","1",":account_id",":user_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"f3300014-1029-4326-80e8-61370cf5b601","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"eb836bf4-05d6-4530-9f2f-f144878014fc","description":{"content":"

(Required) The unique <<glossary:User ID>> of a Kissflow user. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"user_id"}]}},"response":[{"id":"643aaade-08df-4cf4-b444-159f7ead6195","name":"This request retrieves the user details of a particular user.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/user/1/:account_id/:user_id","host":["https://subdomain.kissflow.com"],"path":["user","1",":account_id",":user_id"],"variable":[{"key":"account_id"},{"key":"user_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": -24542202\n },\n {\n \"_id\": \"dolore laborum qui Duis do\"\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n}"}],"_postman_id":"fb5ba026-b803-40cd-9f26-968cfebf8105"}],"id":"5dde8cc6-53d9-4841-a0a5-b05c159804cd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b0dbf4cd-0146-4ef1-a40f-ad1a4883a8db","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"80916987-1f90-4d0d-b5a0-7dc9c469c11a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"5dde8cc6-53d9-4841-a0a5-b05c159804cd","description":""},{"name":"Group","item":[{"name":"Create a new group","id":"b60907fb-a400-404d-ba92-a5ffaa213114","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Description\": \"\",\n \"Groups\": {\n \"IsDelete\": \"\"\n },\n \"Users\": {\n \"IsDelete\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/group/1/:account_id/","description":"

This endpoint lets you create a new group in Kissflow.

\n","urlObject":{"path":["group","1",":account_id",""],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"80d7a351-ecf3-4df6-8b18-bf119800bf3d","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"}]}},"response":[{"id":"8e877d80-17d1-45cc-9239-4b31d70a655f","name":"This request creates a new group in Kissflow.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Description\": \"\",\n \"Groups\": {\n \"IsDelete\": \"\"\n },\n \"Users\": {\n \"IsDelete\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"\",\n \"message\": \"\"\n}"},{"id":"8a5cacc4-e741-4e13-a57b-c0d4a0524b02","name":"The request to create a new group in Kissflow could not be processed due to a malformed request syntax. Make sure you've added the Name parameter.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Description\": \"\",\n \"Groups\": {\n \"IsDelete\": \"\"\n },\n \"Users\": {\n \"IsDelete\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"},{"id":"af8390e7-3544-4939-980b-457dadbbb63a","name":"The request to create a new group could not be processed as either the group is already present or you don't have sufficient permission to create one.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Description\": \"\",\n \"Groups\": {\n \"IsDelete\": \"\"\n },\n \"Users\": {\n \"IsDelete\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",""],"variable":[{"key":"account_id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"error_code\": \"\",\n \"args\": {},\n \"en_message\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"b60907fb-a400-404d-ba92-a5ffaa213114"},{"name":"List groups by page","id":"8c13d7e8-cfea-4739-9e85-033e5870f080","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/group/1/:account_id/p1/:page_size?q=","description":"

This endpoint retrieves the list of groups for a specific filter view.

\n","urlObject":{"path":["group","1",":account_id","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[{"description":{"content":"

The search filter string. This is an optional parameter.

\n","type":"text/plain"},"key":"q","value":""}],"variable":[{"id":"b517a457-5a3f-4334-bf3d-6019c6a93a76","description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"37b59c82-4481-4e95-8110-3730ec447f4f","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"10","key":"page_size"}]}},"response":[{"id":"830852cf-8dd4-4fd6-8ce5-6702911bc207","name":"This request retrieves list of all groups based on a selected pagination view.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/p1/:page_size?q=","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id","p1",":page_size"],"query":[{"description":"The search filter string. This is an optional parameter.","key":"q","value":""}],"variable":[{"key":"account_id"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"GroupCount\": \"\",\n \"Name\": \"\",\n \"SyncFrom\": \"\",\n \"UserCount\": \"\"\n },\n {\n \"GroupCount\": \"\",\n \"Name\": \"\",\n \"SyncFrom\": \"\",\n \"UserCount\": \"\"\n }\n]"}],"_postman_id":"8c13d7e8-cfea-4739-9e85-033e5870f080"},{"name":"List groups by page","id":"c32c8348-7477-435e-99dd-35ffd69f0a04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"Sort\": [\n {\n \"Id\": \"\",\n \"Name\": \"DESC\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"DESC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://subdomain.kissflow.com/group/1/:account_id/p1/:page_size?q=","description":"

List Of groups For Admin Group management

\n","urlObject":{"path":["group","1",":account_id","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[{"description":{"content":"

The search filter string. This is an optional parameter.

\n","type":"text/plain"},"key":"q","value":""}],"variable":[{"id":"c91e29e1-759e-4796-b47a-d624852472ff","description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"8f913519-2cf6-4a26-8be9-8e20724b2aee","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"10","key":"page_size"}]}},"response":[{"id":"575eafec-0034-4b5b-adf3-f1a076321b9a","name":"List of groups","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"Sort\": [\n {\n \"Id\": \"\",\n \"Name\": \"DESC\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"DESC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/p1/:page_size?q=","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id","p1",":page_size"],"query":[{"description":"The search filter string. This is an optional parameter.","key":"q","value":""}],"variable":[{"key":"account_id"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"GroupCount\": \"\",\n \"Name\": \"\",\n \"SyncFrom\": \"\",\n \"UserCount\": \"\"\n },\n {\n \"GroupCount\": \"\",\n \"Name\": \"\",\n \"SyncFrom\": \"\",\n \"UserCount\": \"\"\n }\n]"}],"_postman_id":"c32c8348-7477-435e-99dd-35ffd69f0a04"},{"name":"Delete a group","id":"c97bd14d-4674-420d-8f78-a5e505aeb2c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/group/1/:account_id/:group_id","description":"

This endpoint lets you delete a group in Kissflow.

\n","urlObject":{"path":["group","1",":account_id",":group_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"bfcbf391-a5e3-4798-9b7d-7f1bdacf08c2","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"aa22ff1d-2064-4e7d-b420-af71e7fae039","description":{"content":"

(Required) Your Kissflow <<glossary:Group ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"group_id"}]}},"response":[{"id":"c695ed78-9285-4555-83ca-56ea0f8dc699","name":"This request successfully deletes a group from Kissflow.","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/:group_id","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",":group_id"],"variable":[{"key":"account_id"},{"key":"group_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"c97bd14d-4674-420d-8f78-a5e505aeb2c7"},{"name":"Get group details","id":"8cf76617-549e-49f6-8bc5-50b64c9c9f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/group/1/:account_id/:group_id","description":"

This endpoint lets you retrieve the details of individual members of a specific group.

\n","urlObject":{"path":["group","1",":account_id",":group_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"f5e92287-1b8e-4a97-ba74-4545fadc6fe0","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"cdeaa5e5-dc27-4a03-84fc-850e8794b9cb","description":{"content":"

(Required) Your Kissflow <<glossary:Group ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"group_id"}]}},"response":[{"id":"6fbab60e-79c1-44ec-b954-76a8b28e1d79","name":"This request successfully retrieves details about individual users of that group.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/:group_id","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",":group_id"],"variable":[{"key":"account_id"},{"key":"group_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"GroupCount\": \"\",\n \"GroupMembers\": [\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": -61902755.4980466\n },\n {\n \"_id\": 90630540.58648124\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n },\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": true\n },\n {\n \"_id\": \"sit adipisicing\"\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n }\n ],\n \"Name\": \"\",\n \"SyncFrom\": \"\",\n \"UserCount\": \"\"\n}"}],"_postman_id":"8cf76617-549e-49f6-8bc5-50b64c9c9f14"},{"name":"Get group details by page","id":"9b6cd022-0010-482d-a5cc-50553f9f3049","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/group/1/:account_id/:group_id/members/p1/:page_size?fields=","description":"

This endpoint retrieves the user list of a given group for a specific filter view.

\n","urlObject":{"path":["group","1",":account_id",":group_id","members","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[{"description":{"content":"

Specify the fields that are required in API response. You can specify multiple fields as comma separated values.

\n","type":"text/plain"},"key":"fields","value":""}],"variable":[{"id":"46e7eeaa-bf99-49de-968e-fee52ede8cdc","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"8a7681de-e9ce-4e26-8272-78483dbdbe00","description":{"content":"

(Required) Your Kissflow <<glossary:Group ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"group_id"},{"id":"b91ab313-a0f6-4d34-bfba-1bfbed6568e3","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, 100, etc. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"10","key":"page_size"}]}},"response":[{"id":"50ef2336-73ad-434b-a44b-790a22fa67d5","name":"This request retrieves details about individual user records of that group based on a selected pagination view.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/group/1/:account_id/:group_id/members/p1/:page_size?fields=","host":["https://subdomain.kissflow.com"],"path":["group","1",":account_id",":group_id","members","p1",":page_size"],"query":[{"description":"Specify the fields that are required in API response. You can specify multiple fields as comma separated values.","key":"fields","value":""}],"variable":[{"key":"account_id"},{"key":"group_id"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": 58742694\n },\n {\n \"_id\": \"adipisicing\"\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n },\n {\n \"FirstName\": \"\",\n \"Groups\": [\n {\n \"_id\": \"enim nulla a\"\n },\n {\n \"_id\": 59023578\n }\n ],\n \"Kind\": \"\",\n \"LastName\": \"\",\n \"Name\": \"\",\n \"NickName\": \"\",\n \"Phone\": \"\",\n \"ProfilePicture\": \"\",\n \"Status\": \"\",\n \"UserSystemType\": \"\",\n \"UserType\": \"\"\n }\n]"}],"_postman_id":"9b6cd022-0010-482d-a5cc-50553f9f3049"}],"id":"f8a68613-ea36-4cd1-a504-ea3e31c1dfb4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5bdb3049-5891-4083-ab03-909a0126fb4a","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7c0b80db-e973-4029-a60d-dc94fe89f2f7","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"f8a68613-ea36-4cd1-a504-ea3e31c1dfb4","description":""}],"id":"5efe0374-d0ed-445d-99f8-82cef6af82d2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5cc77e0b-41c1-47e5-96d3-cc876a9944f0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"0c58b857-8f54-41b4-8a1b-3c611079c0a9","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"5efe0374-d0ed-445d-99f8-82cef6af82d2","description":""},{"name":"WORKFLOW","item":[{"name":"Processes","item":[{"name":"Get the item list","id":"c2813f8e-ec0f-4a89-a914-b6a70fcb49dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/item/p1/:page_size","description":"

This endpoint lets you retrieve the list of all items from a Kissflow process. Only Process Admins can call this endpoint.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id","item","p1",":page_size"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"id":"09a80944-3078-4c8d-841d-305f4e5fea46","description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"id":"e75bbca7-f4d3-482d-b92e-9536d7683d55","description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"id":"94e04f60-5d7a-4944-965e-d1fff7627c3c","description":{"content":"

(Required) The number of items that can be listed in a page. It can be 10, 25, 50, or 100. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"page_size"}]}},"response":[{"id":"6f56cdae-739a-4e80-b20f-3c5ad7f3dfa9","name":"This request retrieves the list of all items in your process.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/item/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id","admin",":process_id","item","p1",":page_size"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"page_size"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Columns\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"ReadOnly\": \"\",\n \"Type\": \"\",\n \"width\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"ReadOnly\": \"\",\n \"Type\": \"\",\n \"width\": \"\"\n }\n ],\n \"Filter\": {},\n \"Table_TableName\": [\n {\n \"response\": [\n {\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"\"\n },\n \"TotalPrice\": \"\"\n },\n {\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"\"\n },\n \"TotalPrice\": \"\"\n }\n ]\n },\n {\n \"response\": [\n {\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"\"\n },\n \"TotalPrice\": \"\"\n },\n {\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"\"\n },\n \"TotalPrice\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"7400a6e3-c96e-4454-8ec9-ff5525c2eee3","name":"Get the item list","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/item/p1/:page_size","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id","admin",":process_id","item","p1",":page_size"],"variable":[{"key":"account_id","value":"","description":"(Required) Your Kissflow <>. This is a mandatory parameter."},{"key":"process_id","value":"","description":"(Required) Your Kissflow <>. This is a mandatory parameter."},{"key":"page_size","value":"","description":"(Required) The number of items that can be listed in a page. It can be 10, 25, 50, or 100. This is a mandatory parameter."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c2813f8e-ec0f-4a89-a914-b6a70fcb49dd"},{"name":"Delete an item in a process","id":"eeefa233-7260-4eca-b640-989287f4f507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/:instance_id","description":"

This endpoint lets you delete a specific item from your process. Only Process Admins can call this endpoint.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id",":instance_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"description":{"content":"

(Required) Your unique <<glossary:Instance ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"}]}},"response":[{"id":"38d548c0-44f5-4b1b-9de6-02e0f5e3753f","name":"This request retrieves the item details at a specific workflow step in your process.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/:process_id/:instance_id/:activity_instance_id","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id",":process_id",":instance_id",":activity_instance_id"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"instance_id"},{"key":"activity_instance_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Name\": \"\",\n \"_current_assigned_to\": [\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n ],\n \"_current_step\": \"\",\n \"_progress\": \"\"\n}"}],"_postman_id":"eeefa233-7260-4eca-b640-989287f4f507"},{"name":"Get item details","id":"ed1daf47-0598-422a-a44c-4f8d0495cabe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/:instance_id","description":"

This endpoint lets you retrieve the details of a specific item from your Kissflow process. Only Process Admins can call this endpoint.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id",":instance_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"description":{"content":"

(Required) Your unique <<glossary:Instance ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"}]}},"response":[{"id":"863f17c2-e5bf-489d-a5db-8c44c7bd949a","name":"This request retrieves the item details at a specific workflow step in your process.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/:process_id/:instance_id/:activity_instance_id","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id",":process_id",":instance_id",":activity_instance_id"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"instance_id"},{"key":"activity_instance_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Name\": \"\",\n \"_current_assigned_to\": [\n {\n \"Name\": \"\"\n },\n {\n \"Name\": \"\"\n }\n ],\n \"_current_step\": \"\",\n \"_progress\": \"\"\n}"}],"_postman_id":"ed1daf47-0598-422a-a44c-4f8d0495cabe"},{"name":"Update item details","id":"c4a68524-e3d1-45d3-98d6-f2f47d42746a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"*/*"}],"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/:instance_id","description":"

This endpoint helps you update the records of a specific item in your process. Only Process Admins can call this endpoint.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id",":instance_id"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"

(Required) Your Kissflow <<glossary:Account ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"description":{"content":"

(Required) Your unique <<glossary:Instance ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"}]}},"response":[{"id":"806517cf-8035-47f1-bb0a-240f06f0a4fa","name":"This request retrieves the progress details of a specific item in your process.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/:process_id/:instance_id/progress","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id",":process_id",":instance_id","progress"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"instance_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"steps\": [\n {\n \"Type\": \"\"\n },\n {\n \"Type\": \"\"\n }\n ]\n}"}],"_postman_id":"c4a68524-e3d1-45d3-98d6-f2f47d42746a"},{"name":"Add attachment to form field as admin","id":"d8a9ef51-6745-45f3-917d-ffe4ff4a20f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"*/*"}],"body":{"mode":"formdata","formdata":[{"description":"

This is the file that you upload.

\n","key":"file","type":"file","value":null}]},"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/:instance_id/:field_id/attachment","description":"

This endpoint lets you upload an attachment file to your process' form field. You can add an attachment in the following file formats - .pdf, .doc, .ppt, .xls, .jpg, .jpeg, .jpe, .png, .gif, or .mp4. Only the Flow Admin can invoke this API.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id",":instance_id",":field_id","attachment"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"description":{"content":"

(Required) The <<glossary:Instance ID>> is a unique identifier for an individual item, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"},{"description":{"content":"

(Required) The unique identifier assigned to each field of your process form. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"field_id"}]}},"response":[{"id":"c586d283-42eb-427f-ae3f-47ba837bd6c5","name":"This request successfully adds a new attachment to your process form field.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"formdata","formdata":[{"description":"This is the file that you upload.","key":"file","type":"file","src":[]}]},"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/:process_id/:instance_id/:activity_instance_id/:field_id/attachment","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id",":process_id",":instance_id",":activity_instance_id",":field_id","attachment"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"instance_id"},{"key":"activity_instance_id"},{"key":"field_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"\"\n },\n \"TotalPrice\": \"\"\n}"}],"_postman_id":"d8a9ef51-6745-45f3-917d-ffe4ff4a20f1"},{"name":"Add image to form field as admin","id":"cbf9ab66-22d6-4e4b-8cec-5788782d4c3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-Api-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"*/*"}],"body":{"mode":"formdata","formdata":[{"description":"

This is the file that you upload.

\n","key":"file","type":"file","value":null}]},"url":"https://subdomain.kissflow.com/process/1/:account_id/admin/:process_id/:instance_id/:field_id/image","description":"

This endpoint lets you upload an image file to your process' form field. You can add an image in the following file formats - .jpg, .jpeg, .jpe, .png, or .gif. Only the Flow Admin can invoke this API.

\n","urlObject":{"path":["process","1",":account_id","admin",":process_id",":instance_id",":field_id","image"],"host":["https://subdomain.kissflow.com"],"query":[],"variable":[{"description":{"content":"

(Required) This is your Kissflow <<glossary:Account ID>>, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"account_id"},{"description":{"content":"

(Required) Your Kissflow <<glossary:Process ID>>. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"process_id"},{"description":{"content":"

(Required) The <<glossary:Instance ID>> is a unique identifier for an individual item, and is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"instance_id"},{"description":{"content":"

(Required) The unique identifier assigned to each field of your process form. This is a mandatory parameter.

\n","type":"text/plain"},"type":"any","value":"","key":"field_id"}]}},"response":[{"id":"af57faf4-b5df-4895-91c2-b6a935573979","name":"This request successfully adds a new image file to your process form field.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"*/*"},{"description":"Added as a part of security scheme: apikey","key":"X-Api-Key","value":""}],"body":{"mode":"formdata","formdata":[{"description":"This is the file that you upload.","key":"file","type":"file","src":[]}]},"url":{"raw":"https://subdomain.kissflow.com/process/1/:account_id/:process_id/:instance_id/:activity_instance_id/:field_id/image","host":["https://subdomain.kissflow.com"],"path":["process","1",":account_id",":process_id",":instance_id",":activity_instance_id",":field_id","image"],"variable":[{"key":"account_id"},{"key":"process_id"},{"key":"instance_id"},{"key":"activity_instance_id"},{"key":"field_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Name\": \"\",\n \"PONumber\": \"\",\n \"RequestedBy\": {\n \"Name\": \"