Kaiten icon

Kaiten

Interact with Kaiten API (read operations only)

Actions8

Overview

This node interacts with the Kaiten API to retrieve cards from a specific column within a board. It is designed to fetch all cards that belong to a given column, optionally applying various query filters to narrow down the results. This operation is useful in project management workflows where you want to analyze or process tasks/cards currently in a particular stage (column) of a board.

Common scenarios:

  • Extracting all tasks/cards currently in a "To Do" or "In Progress" column for reporting.
  • Automating notifications or updates based on cards in a specific column.
  • Integrating Kaiten card data into other systems by fetching cards from a targeted column.

Practical example:
You have a board representing a sprint backlog and want to get all cards in the "In Progress" column to send daily status updates. Using this node, you select the space, board, and column, and optionally apply filters like due date or tags to refine the list of cards retrieved.

Properties

Name Meaning
Space Select the Kaiten space containing the board.
Board Select the board within the chosen space from which to get cards.
Column Select the specific column within the board to retrieve cards from.
Send Query Parameters Boolean flag indicating whether to send additional query parameters to filter the cards.
Query Parameters A collection of key-value pairs representing query parameters to filter the cards. Available parameters include text search (query), date filters (created_before, due_date_after, etc.), tag filters, state filters, and more.

The Query Parameters options include (but are not limited to):

  • query: Text search filter on card content.
  • created_before, created_after: Filter cards created before/after a certain ISO 8601 date.
  • updated_before, updated_after: Filter cards updated before/after a certain ISO 8601 date.
  • tag, tag_ids: Filter by tag name or IDs.
  • states: Filter by card states such as queued, in progress, done.
  • limit: Maximum number of cards to return (max 100).
  • offset: Number of records to skip.
  • Various ID filters for boards, lanes, columns, members, owners, and responsible users.
  • Flags like archived, asap, overdue, done_on_time, with_due_date.
  • Sorting options like order_by and order_direction.

Output

The node outputs an array of card objects in JSON format. Each item corresponds to a card retrieved from the specified column, including all available card properties returned by the Kaiten API.

  • The output JSON contains detailed card information such as card ID, title, description (if requested), state, tags, dates, and assigned members.
  • No binary data is output by this node.

Example output structure (simplified):

[
  {
    "id": 123,
    "title": "Implement feature X",
    "description": "Detailed description here",
    "state": 2,
    "tags": ["urgent", "backend"],
    "created_at": "2023-01-10T12:00:00Z",
    "due_date": "2023-01-20T12:00:00Z",
    ...
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Kaiten API.
  • The node makes HTTP GET requests to the Kaiten API endpoints.
  • The user must configure the API server URL and provide valid credentials.
  • The node depends on n8n's built-in HTTP request helper with authentication support.

Troubleshooting

  • Empty results: Ensure the selected space, board, and column IDs are correct and that cards exist in the specified column.
  • Invalid query parameters: If using query parameters, verify their names and values conform to expected formats (e.g., ISO 8601 for dates).
  • Authentication errors: Check that the API key credential is valid and has sufficient permissions.
  • API rate limits or connectivity issues: Network problems or API throttling may cause failures; retry or check API usage limits.
  • Parsing errors: Rarely, malformed API responses might cause JSON parsing errors; ensure the API server is stable.

If the node throws an error, it will provide the error message from the API or a generic message if unknown. Use the error details to adjust parameters or credentials accordingly.

Links and References


This summary covers the static analysis of the node's execute method for the "Card" resource and "Get All from Column" operation, focusing on input properties, output, dependencies, and common troubleshooting points.

Discussion