KaitenInstall

Overview

This node interacts with the Kaiten API to retrieve information about cards, specifically supporting the "Get All" operation for cards. It allows users to fetch multiple cards from Kaiten with advanced filtering options. This is useful in scenarios where you want to list or analyze cards based on various criteria such as creation date, status, tags, ownership, and more.

Practical examples include:

• Retrieving all cards assigned to a specific user or owner.
• Filtering cards that are overdue or have a due date set.
• Searching cards containing specific text or tags.
• Getting cards from a particular board, column, or lane with additional filters.
• Paginating through large sets of cards by using limit and offset parameters.

Properties

Output

The node outputs an array of card objects in JSON format. Each item corresponds to a card retrieved from the Kaiten API and includes all standard card properties plus any additional fields requested (such as description).

The output structure is:

{
  "json": {
    // card properties as returned by Kaiten API, e.g.:
    "id": 123,
    "title": "Card title",
    "description": "Card description", // if requested
    "state": 2,
    "tags": [...],
    "due_date": "2024-06-30T12:00:00Z",
    // ... other card fields
  },
  "pairedItem": {
    "item": <index of input item>
  }
}

No binary data is output by this node.

Dependencies

• Requires an API key credential for authenticating with the Kaiten API.
• The node uses the base URL configured in the credential to make requests to Kaiten's REST API endpoints.
• No additional environment variables are required beyond the API authentication setup.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication errors.
  • Using unsupported or incorrectly formatted query parameters may result in API errors or empty responses.
  • Requesting too many cards (above 100) will be limited by the API; use pagination with limit and offset.
  • Network connectivity issues can cause request failures.

• Error messages:

  • Authentication errors typically indicate invalid API keys or expired tokens. Verify and update credentials.
  • "Unknown error" may occur if the API returns unexpected responses; check API availability and parameter correctness.
  • If the node fails but "Continue on Fail" is enabled, errors will be returned in the output JSON under an error property.

Links and References

• Kaiten API Documentation (official API docs for reference on available endpoints and parameters)
• ISO 8601 Date Format (for date/time filter formatting)