Kintone (Tech Preview) operation
The Kintone connector defines how to interact with your Kintone applications and enables specific actions such as Query, Create, Update, Delete, File Upload and File Download. These actions are performed against specific Kintone object types, including Records, Files, and Applications.
For each object required for your integration, create a separate operation component. The set of supported operations may vary depending on the selected object type. Supported Actions: Query, Create, Update, Delete, File Upload and File Download.
The connector currently supports only V1 of the Kintone API.
The following fields are available for all operations during browse.
Query operation
The Query action is an inbound operation that uses filtering criteria to retrieve Kintone records from specified applications. Upon successful execution, it returns a JSON response containing details of the retrieved records, including their unique IDs and field values.
Key features
- Supports complex filtering with multiple operators based on field types
- Enables field selection to retrieve only required data
- Supports sorting and pagination for large result sets
- Handles up to 10,500 records per query operation
- Supports sub table field querying and filtering
Supported operators for Field Types
| Field Type | Description | Supported Operators |
|---|---|---|
| Single Line Text | Basic text input | =, !=, in, not in, like, not like |
| Link | URL field | =, !=, in, not in, like, not like |
| Multi Line Text | Multi-line text area | like, not like, is, is not |
| Rich Text | Formatted text with HTML | like, not like |
| Number | Numeric values | =, !=, >, <, >=, <=, in, not in |
| Calc | Calculated field | =, !=, >, <, >=, <=, in, not in |
| Check Box | Multiple selections | in, not in |
| Radio Button | Single selection | in, not in |
| Drop Down | Single selection from list | in, not in |
| Multi Select | Multiple selections from list | in, not in |
| Date | Date picker | =, !=, >, <, >=, <= |
| Time | Time picker | =, !=, >, <, >=, <= |
| DateTime | Date and time picker | =, !=, >, <, >=, <= |
| User Select | User selection | in, not in |
| Organization Select | Organization selection | in, not in |
| Group Select | Group selection | in, not in |
| File | File attachment | like, not like |
| Status | Workflow status | =, !=, in, not in |
| Status Assignee | Status assignee | in, not in |
| Record Number | Auto-generated record number | =, !=, >, <, >=, <=, in, not in |
| ID | Record ID | =, !=, >, <, >=, <=, in, not in |
| Creator | Record creator | in, not in |
| Modifier | Last modifier | in, not in |
| Created Time | Creation timestamp | =, !=, >, <, >=, <= |
| Updated Time | Last update timestamp | =, !=, >, <, >=, <= |
| Subtable | Table with multiple rows | in, not in, like, not like |
| Lookup | Reference to other records | =, !=, >, <, >=, <=, in, not in, like, not like |
| Category | Category field | in, not in |
Query functions
The connector supports Kintone query functions for dynamic filtering.
| Function | Description | Usage Example |
|---|---|---|
| LOGINUSER() | Current logged-in user | Creator = LOGINUSER() |
| PRIMARY_ORGANIZATION() | Current user's primary organization | Organization = PRIMARY_ORGANIZATION() |
| NOW() | Current date and time | Created_Time > NOW() |
| TODAY() | Current date | Date_Field = TODAY() |
| YESTERDAY() | Previous day | Date_Field = YESTERDAY() |
| TOMORROW() | Next day | Date_Field = TOMORROW() |
| THIS_WEEK() | Current week | Date_Field = THIS_WEEK() |
| THIS_WEEK(day) | Current week starting from specific day | Date_Field = THIS_WEEK(MONDAY) |
| LAST_WEEK() | Previous week | Date_Field = LAST_WEEK() |
| LAST_WEEK(day) | Previous week starting from specific day | Date_Field = LAST_WEEK(SUNDAY) |
| NEXT_WEEK() | Next week | Date_Field = NEXT_WEEK() |
| NEXT_WEEK(day) | Next week starting from specific day | Date_Field = NEXT_WEEK(FRIDAY) |
| THIS_MONTH() | Current month | Date_Field = THIS_MONTH() |
| THIS_MONTH(day) | Current month with specific day | Date_Field = THIS_MONTH(15) |
| LAST_MONTH() | Previous month | Date_Field = LAST_MONTH() |
| LAST_MONTH(day) | Previous month with specific day | Date_Field = LAST_MONTH(LAST) |
| NEXT_MONTH() | Next month | Date_Field = NEXT_MONTH() |
| NEXT_MONTH(day) | Next month with specific day | Date_Field = NEXT_MONTH(LAST) |
| THIS_YEAR() | Current year | Date_Field = THIS_YEAR() |
| LAST_YEAR() | Previous year | Date_Field = LAST_YEAR() |
| NEXT_YEAR() | Next year | Date_Field = NEXT_YEAR() |
| FROM_TODAY(n, unit) | Relative date from today | Date_Field = FROM_TODAY(7, DAYS) |
The Maximum number of records supported by Kintone Query operation is 10,500.
The Maximum Records field, an operation property, enables pagination by specifying the highest number of records to retrieve. Each response document contains one record. The default value is 10,000 and you can set it to any number between 1 and 10,500.
Create operation
The Create action is an outbound operation that uses JSON input to create new Kintone records. Upon successful execution, it returns a JSON response containing details of the newly created record, including its unique ID and revision number.
Key features
- Automatically handles batching in the background to optimize API quota usage
- Handles all Kintone field types including sub tables and file attachments
- Provides field validation against app field definitions
- Returns created record IDs and revision numbers for tracking
- Processes multiple records efficiently without user intervention
Update operation
The Update action is an outbound operation that takes a JSON document as input to modify information for a record in Kintone. The input document must include an ID field or updateKey that specifies the record to be updated.
Key features
- Automatically handles batching in the background to optimize API quota usage
- Multiple update methods: by Record ID or by Unique Key
- Handles partial updates - only specified fields are modified
- Supports optimistic locking with revision numbers
- Processes multiple records efficiently without user intervention
When you perform an update, omitting the subtable (sub-records) section leaves the subtables unchanged. To update specific subtable rows, include their row IDs in your request—even if their values remain the same. If you omit the IDs of existing rows, the system deletes those rows.
Update methods
By Record ID
- Use when you know the specific
record ID - Include the
record IDin your input data - Map the fields you want to update
By Unique Key
- Use when you have a unique field like email or customer ID
- Configure the
updateKeyfield in your mapping - Specify both the field name and value
Object-Specific Support
- For all object types, both ID and
updateKeyare supported - The
updateKeyrequires a unique field in your Kintone app - ID field contains the value of
record IDorupdateKeyas per the operation configuration
Delete operation
The Delete action is an outbound operation used to delete Kintone records using the record's ID as input.
Key features
The ID can be provided in two ways:
- As a connector parameter
- Through an XML input profile
The ID field supports multiple entries, enabling the deletion of multiple records efficiently. The connector automatically handles batching in the background to optimize API quota usage. The response is a JSON object indicating the success or failure of the delete request for each ID provided.
Deleted records cannot be recovered. Ensure you have the necessary permissions and verify the records before deletion.
File upload operation
The File Upload action is an outbound operation used to upload files to Kintone's temporary storage. Upon successful execution, it returns a fileKey that can be used with Create or Update operations to attach files to records.
Key features
- Supports all file types allowed by Kintone
- Preserves file metadata, including name and content type
- Returns fileKey for use in record operations
- Uses multipart/form-data format for upload
Dynamic properties
- The
fileNameis the required file name for the upload
File download operation
The File Download action is an inbound operation used to download files from Kintone using a fileKey. The response contains the binary file content with metadata.
Key features
- Downloads files using fileKey from record data
- Preserves original file name, content type, and size
- Handles file not found and permission errors gracefully
Response methods
- Content-Type: Based on original file type
- Content-Disposition: Includes original filename
- Body: Binary file content
You can configure file upload and download operations using the Static Profile option without selecting an application.
