Kaiten icon

Kaiten

Interact with Kaiten API (read operations only)
Join our community

Actions8

Overview

This node interacts with the Kaiten API to retrieve cards from a specific board. The "Get All from Board" operation fetches all cards associated with a selected board within a chosen space. It supports optional query parameters for filtering and refining the results, such as date filters, tags, states, and pagination controls.

This node is beneficial when you want to automate workflows that involve managing or analyzing tasks/cards on a Kaiten board. For example, you could use it to:

  • Retrieve all active tasks on a project board to generate reports.
  • Filter cards by due dates or tags to trigger notifications or reminders.
  • Integrate Kaiten card data into other systems like CRM or analytics platforms.

Properties

Name Meaning
Space Select the Kaiten space containing the board.
Board Select the specific board within the chosen space from which to get all cards.
Send Query Parameters Boolean flag to decide whether to send additional query parameters for filtering the cards.
Query Parameters A collection of key-value pairs representing query parameters to filter the cards. Available options include: query (text search), date filters (created_before, created_after, etc.), tag filters, state filters, pagination (limit, offset), sorting (order_by, order_direction), and many others as detailed below.

Query Parameters Options (Name / Meaning)

  • query: Text search filter for card content.
  • created_before, created_after: Filter cards created before/after a given ISO 8601 date.
  • updated_before, updated_after: Filter cards updated before/after a given ISO 8601 date.
  • first_moved_in_progress_after, first_moved_in_progress_before: Filter by first moved in progress date.
  • last_moved_to_done_at_after, last_moved_to_done_at_before: Filter by last moved to done date.
  • due_date_after, due_date_before: Filter by due date.
  • tag: Filter by tag text.
  • tag_ids: Filter by tag IDs (comma separated).
  • type_ids: Filter by type IDs (comma separated).
  • exclude_board_ids, exclude_lane_ids, exclude_column_ids: Exclude specified boards, lanes, or columns.
  • column_ids: Filter by column IDs.
  • member_ids, owner_ids, responsible_ids: Filter by member, owner, or responsible user IDs.
  • states: Filter by card states (1-queued, 2-inProgress, 3-done).
  • external_id: Filter by external ID.
  • additional_card_fields: Request additional fields such as description.
  • search_fields: Specify fields to search by.
  • space_id, board_id, column_id, lane_id: Filters by respective IDs.
  • condition: Filter by condition (1-on board, 2-archived).
  • type_id, responsible_id, owner_id: Additional filters by IDs.
  • archived, asap, overdue, done_on_time, with_due_date: Boolean flags for various card attributes.
  • filter: Base64 encoded complex filter (Beta).
  • limit: Maximum number of cards to return (max 100).
  • offset: Number of records to skip.
  • order_space_id: Order by space ID.
  • order_by: Fields for sorting (comma separated).
  • order_direction: Sort direction ("asc" or "desc").

Output

The output is an array of items where each item contains a json object representing a single card retrieved from the specified board. Each card object includes all standard card properties returned by the Kaiten API, such as card ID, title, description (if requested), state, assigned members, tags, dates, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kaiten API.
  • The node uses the Kaiten API endpoints under /api/latest/cards with appropriate query parameters.
  • Proper configuration of the API server URL and authentication credentials in n8n is necessary.

Troubleshooting

  • Empty Results: If no cards are returned, verify that the selected space and board IDs are correct and that any applied query parameters are not overly restrictive.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access the Kaiten API.
  • Invalid Date Formats: Date filters must be provided in ISO 8601 format; otherwise, the API may reject the request.
  • Query Parameter Formatting: When using multiple query parameters, ensure values are correctly encoded and comma-separated lists are properly formatted.
  • API Rate Limits: Excessive requests might hit rate limits imposed by the Kaiten API; consider adding delays or reducing request frequency.
  • Error Messages: Errors from the API will be surfaced in the node's output if "Continue On Fail" is enabled; otherwise, they will stop execution. Common errors include invalid IDs, missing required parameters, or malformed queries.

Links and References

Discussion