Actions13
Overview
The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling operations related to Pickaxe resources such as studios, documents, pickaxes, and products. The "List Documents" operation retrieves a paginated list of documents associated with a specified studio. This is useful for workflows that need to fetch and process document metadata or content from Pickaxe, such as automating document management, reporting, or integration with other systems.
Practical examples include:
- Automatically retrieving recent documents from a specific studio for further processing.
- Building dashboards that display document lists filtered by studio.
- Integrating document data into CRM or ERP systems.
Properties
| Name | Meaning |
|---|---|
| Studio | Select the studio from which to list documents. You can choose from a dropdown list or specify an ID using an expression. This determines the scope of documents retrieved. |
| Skip | Number of records to skip for pagination purposes. Useful for fetching subsequent pages of results. Default is 0 (no skipping). |
| Take | Maximum number of document records to return in one request. Controls page size. Default is 10. |
Output
The node outputs JSON data containing a list of documents retrieved from the Pickaxe API. Each item in the output corresponds to a document object with properties as returned by the API (such as document name, ID, and potentially other metadata). The exact structure depends on the Pickaxe API response but typically includes identifiers and descriptive fields for each document.
No binary data output is indicated for this operation.
Dependencies
- Requires an active API authentication token configured via OAuth2 credentials for Pickaxe API access.
- The node makes HTTP requests to
https://api.pickaxe.co/v1endpoints. - Proper configuration of the Pickaxe API OAuth2 credential within n8n is necessary for successful requests.
Troubleshooting
- Authentication errors: Ensure the OAuth2 credentials are correctly set up and have not expired.
- Empty results: Verify that the selected studio contains documents; also check pagination parameters (
SkipandTake) to ensure they are within valid ranges. - API request failures: Network issues or incorrect base URL could cause failures. Confirm internet connectivity and that the base URL has not changed.
- Invalid studio ID: If specifying the studio ID manually, ensure it matches an existing studio accessible by the authenticated user.
Links and References
- Pickaxe API Documentation (assumed official docs for more details)
- n8n Expressions Documentation - for using expressions in property values