# Kizeo Forms

Kizeo Forms is a form digitization tool designed to collect data on the move. This mobile forms application for data collection supports diverse capabilities:

**Get Data Definition**

Get the definition of a data

**Push Data**

Push a data to a form

**Download Standard PDF**

Get PDF data of a form

**Download custom export in its original format**

Download a custom export in its original format

**Get List Definition**

Get the definition of a list

**Get List Item**

Get a specific item from a list

**Get All List Items**

Get all items from a specific list

**Create List Item**

Create a new list item in Kizeo Forms

**Edit List Item**

Edit a specific item in a list

**Delete List Item**

Delete a specific item from a list

**Custom API Call**

Send a custom API call to a specific endpoint

### **How to Connect Kizeo Forms to ZBrain Flow?** <a href="#how-to-connect-kizeo-forms-to-zbrain-flow" id="how-to-connect-kizeo-forms-to-zbrain-flow"></a>

To integrate Kizeo Forms with ZBrain Flow, follow these steps to select and utilize the desired capabilities:

1. **Search for the Kizeo Forms Component**: Search the Kizeo Forms component within the ZBrain interface.
2. **Set up Connection:** For setting up the connection:
   * **Connection Name**: Label for the connection to easily identify it in your configurations.
   * **Kizeo Forms API Key**: Place where you input the API key provided by Kizeo Forms to establish a secure connection.
3. **Select the Required Capability**: Based on your requirement, select the desired component.

### **Additional Settings to Get Data Definition** <a href="#additional-settings-to-get-data-definition" id="additional-settings-to-get-data-definition"></a>

1. **Kizeo Forms API Key**: This field requires an API token from Kizeo Forms, necessary to authenticate and enable API access.
2. **Form**: Select the specific form from your Kizeo Forms account to interact with.
3. **Data Id**: Enter the unique identifier for the data within the form you wish to access.

### **Additional Settings to Push Data Definition** <a href="#additional-settings-to-push-data-definition" id="additional-settings-to-push-data-definition"></a>

* **Kizeo Forms API Key**: The required API token to authenticate your connection with Kizeo Forms.
* **Form**: Specify the form to which you want to push data.
* **User**: Select the user account under which the data will be submitted.

### **Additional Settings to Download Standard PDF** <a href="#additional-settings-to-download-standard-pdf" id="additional-settings-to-download-standard-pdf"></a>

* **Kizeo Forms API Key**: The required API token to authenticate your connection with Kizeo Forms.
* **Form**: Select the form from which you want to download a PDF.
* **Data Id**: The unique identifier of the data entry for which the PDF will be generated.

### **Additional Settings to Download Custom Export In Its Original Format** <a href="#additional-settings-to-download-custom-export-in-its-original-format" id="additional-settings-to-download-custom-export-in-its-original-format"></a>

* **Kizeo Forms API Key**: Enter your API key to establish a secure connection to Kizeo Forms.
* **Form**: Select the form from which you want to download custom export data.
* **Export**: Choose the specific custom export configuration set up in Kizeo Forms.
* **Export in PDF**: Toggle this option to download the export in PDF format.
* **Data Id**: Input the unique identifier for the data you wish to export.

### **Additional Settings to Get List Definition** <a href="#additional-settings-to-get-list-definition" id="additional-settings-to-get-list-definition"></a>

* **Kizeo Forms API Key**: Enter your API key to authenticate and access the list definitions.
* **Select a connection**: Choose a predefined connection to Kizeo Forms.
* **List**: Select the specific list for which you want to retrieve the definition.

### **Additional Settings to Get List Item** <a href="#additional-settings-to-get-list-item" id="additional-settings-to-get-list-item"></a>

* **Kizeo Forms API Key**: Enter your API key to authorize access to list items.
* **Select a connection**: Choose from available connections to Kizeo Forms.
* **List**: Specify the list from which you want to retrieve an item.
* **Item Id**: Enter the ID of the list item you wish to retrieve.

### **Additional Settings to Get All List Items** <a href="#additional-settings-to-get-all-list-items" id="additional-settings-to-get-all-list-items"></a>

* **Kizeo Forms API Key**: Authenticate your request by entering the API key.
* **Select a connection**: Choose a connection for accessing Kizeo Forms.
* **Search**: Enter a pattern to search within the list items.
* **Offset**: Specify the starting point for data retrieval to manage pagination.
* **Limit**: Set the maximum number of list items to retrieve in one request.
* **Sort**: Define the field you want to sort the list items by.
* **Direction**: Choose the sorting order, ascending (asc) or descending (desc).
* **List**: Select the specific list from which you want to retrieve all items.

### **Additional Settings to Create List Item** <a href="#additional-settings-to-create-list-item" id="additional-settings-to-create-list-item"></a>

* **Connection:** Choose your connection to access the platform.
* **List:** Identify the specific list to add an item.
* **Item Label:** Provide a label for the new item in the list.

### **Additional Settings to Edit List Item** <a href="#additional-settings-to-edit-list-item" id="additional-settings-to-edit-list-item"></a>

* **Connection:** Select your connection to access platform features.
* **List:** Specify the list containing the item to edit.
* **Item ID:** Enter the ID of the item you wish to modify.
* **Item Label:** Update the label for the existing list item.

### **Additional Settings to Delete List Item** <a href="#additional-settings-to-delete-list-item" id="additional-settings-to-delete-list-item"></a>

* **Connection:** Select your connection for API access.
* **List:** Choose the specific list from which the item will be deleted.
* **Item ID:** Enter the unique identifier of the item you want to remove from the list.

### **Additional Settings to Custom API Call** <a href="#additional-settings-to-custom-api-call" id="additional-settings-to-custom-api-call"></a>

* **Connection:** Choose your API connection for Kizeo Forms.
* **URL:** Enter the endpoint URL where the API request will be sent.
* **Method:** Select the HTTP method (GET, POST, etc.) to use for the API call.
* **Headers:** Add any necessary headers to your request.
* **Query Parameters:** Input parameters required for the query.
* **Body:** Include the body content for POST or PUT requests.
* **Timeout:** Set the timeout in seconds for the API call to respond.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.zbrain.ai/zbrain-documentation/zbrain-builder/flows/flow-components/kizeo-forms.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
