Pickaxe icon

Pickaxe

Interact with the Pickaxe APIs

Overview

The Pickaxe node allows users to interact with the Pickaxe API, specifically enabling retrieval of user information within a given studio. The "Get User" operation fetches details about a user by their email address from a selected studio.

This node is useful in scenarios where you need to automate workflows involving user data management in Pickaxe studios, such as syncing user profiles, verifying user existence before further processing, or integrating Pickaxe user data into other systems.

Example use case: Automatically retrieve a user's profile by email when a new form submission occurs, then update a CRM system with that user's details.

Properties

Name Meaning
Studio Select the studio from which to retrieve the user. Options are dynamically loaded from Pickaxe.
User Email The email address of the user whose information you want to retrieve.

Output

The node outputs JSON data containing the retrieved user information from the Pickaxe API. This typically includes user profile details associated with the specified email within the chosen studio.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for Pickaxe.
  • The node makes authenticated HTTP requests to the Pickaxe API endpoint at https://api.pickaxe.co/v1.
  • The "Studio" options are dynamically loaded from the Pickaxe API using the authenticated session.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Specifying a non-existent studio or user email may result in empty or error responses.
    • Network connectivity problems can prevent successful API calls.
  • Error messages and resolutions:

    • Authentication errors: Verify that the OAuth2 credentials are correctly set up and have not expired.
    • User not found: Confirm the email address exists in the selected studio.
    • Studio list loading fails: Check API access permissions and network connectivity.

Links and References

Discussion