Gomake icon

Gomake

Interact with the Gomake API

Overview

This node integrates with the Gomake API to search for customers based on specific criteria. It is useful in scenarios where you need to retrieve a filtered list of clients from the Gomake system, such as when managing customer databases, generating reports, or syncing client data with other systems.

For example, you can use this node to:

  • Find all active customers whose names partially match a given string.
  • Filter clients by type (Customer or Supplier).
  • Paginate through large sets of client data efficiently.

Properties

Name Meaning
Name Client name to search for (partial match).
Client Type Filter by client type: "Customer" or "Supplier".
Is Active Whether to filter only active clients (true or false).
Page Number Page number for pagination (minimum 1).
Page Size Number of items per page (minimum 1).

Output

The node outputs an array of JSON objects representing the customers matching the search criteria. Each object corresponds to a customer record returned by the Gomake API's paginated search endpoint.

The output structure includes all fields provided by the Gomake API under the /v1/customers/get-customers-pagination endpoint. The exact fields depend on the API response but typically include customer details such as name, type, status, and other metadata.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the Gomake API.
  • The node performs authentication by sending credentials (user principal name, password, and optional timezone offset) to the Gomake login endpoint.
  • The base URL used is https://ui-backend.staging.gomake.net.
  • Proper configuration of the Gomake API credentials within n8n is necessary.

Troubleshooting

  • Authentication Failure: If the node throws an error stating "Failed to authenticate with Gomake API. Please check your credentials," verify that the provided user principal name and password are correct and that the API credentials are properly configured in n8n.
  • Empty Results: If no customers are returned, ensure that the search parameters (name, client type, active status) are correctly set and that matching records exist in the Gomake system.
  • Pagination Issues: If you receive fewer results than expected, check the Page Number and Page Size properties to ensure they are set appropriately.
  • API Endpoint Changes: Since the node uses a staging URL, confirm that the endpoint URLs have not changed or require updates.

Links and References

Discussion