Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling operations related to Pickaxe resources such as studios, documents, pickaxes (forms), and products. The "List Users" operation under the "Pickaxe" resource fetches a paginated list of users associated with a selected studio. This is useful for scenarios where you need to manage or analyze user data within a specific studio context in Pickaxe, such as syncing user lists, auditing user access, or integrating user information into other workflows.

Practical examples:

  • Retrieve a list of users from a particular studio to send targeted notifications.
  • Export user data for reporting or analytics.
  • Automate user management tasks by integrating with other systems.

Properties

Name Meaning
Studio Select the studio from which to list users. You can choose from a dropdown list or specify an ID using an expression.
Skip Number of records to skip for pagination purposes. Useful for fetching subsequent pages of users. Defaults to 0.
Take Maximum number of user records to return in one request. Defaults to 10.

Output

The node outputs JSON data containing the list of users retrieved from the Pickaxe API for the specified studio. Each item in the output corresponds to a user record with details as provided by the API. The exact structure depends on the Pickaxe API response but typically includes user identifiers and relevant metadata.

No binary data output is indicated.

Dependencies

  • Requires an API key credential configured for authenticating with the Pickaxe API via OAuth2.
  • The node makes HTTP requests to https://api.pickaxe.co/v1 endpoints.
  • Proper configuration of the Pickaxe API OAuth2 credentials in n8n is necessary for successful authentication.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly set up and has valid permissions.
  • Empty results: Verify that the selected studio contains users and that pagination parameters (Skip, Take) are set appropriately.
  • API rate limits or connectivity issues: Check network connectivity and Pickaxe API status.
  • Invalid studio selection: If no studios appear in the dropdown, confirm that the API credentials have access to studios and that the account has studios created.

Links and References

Discussion