Joplin icon

Joplin

Consume Joplin API

Actions9

Folder → Get

AI-generated

Overview

This node interacts with the Joplin API to retrieve information about a specific folder. The "Folder: Get" operation fetches details for a folder given its ID or name. This is useful in workflows where you need to look up folder metadata, verify existence, or use folder properties in subsequent automation steps.

Example scenarios:

  • Retrieve folder details to route notes into the correct location.
  • Validate that a folder exists before creating new notes within it.
  • Use folder metadata (like title or parent ID) in conditional logic or reporting.

Properties

Name Type Meaning
Folder Name or ID options ID of the folder to retrieve. You can select from a list or specify an ID using an expression.

Output

The output will be a JSON object containing the details of the requested folder as returned by the Joplin API. Typical fields may include:

{
  "id": "string",
  "parent_id": "string",
  "title": "string",
  "created_time": "number",
  "updated_time": "number"
  // ...other folder properties provided by Joplin
}
  • The exact structure depends on the Joplin API's response for a folder resource.
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to a running Joplin server with its API enabled.
  • Credentials: Needs a configured jApi credential in n8n, which must include:
    • baseUrl: The base URL of your Joplin API instance.
    • token: An API token for authentication.

Troubleshooting

Common issues:

  • Invalid Folder ID: If the provided folder ID does not exist, the node will throw an error. Double-check the ID or use the dropdown to select a valid folder.
  • Authentication Errors: If credentials are missing or incorrect, you may see errors related to authorization or connection failures.
  • Joplin Server Unreachable: Network issues or incorrect baseUrl will result in connection errors.

Error messages and resolutions:

  • "Cannot read property '...' of undefined": Likely due to an invalid or missing folder ID. Ensure the input is correct.
  • "Request failed with status code 401": Authentication failed. Check your API token and base URL.
  • "ENOTFOUND" or similar network errors: Verify the Joplin server address and network connectivity.

Links and References

Discussion