GymControl icon

GymControl

Handle your GymControl instance

Actions91

Overview

This node interacts with the GymControl API to manage and retrieve data related to various gym management resources. Specifically, for the Worksheet - Get operation, it fetches a single worksheet by its unique ID from the GymControl system. This is useful when you want to retrieve detailed information about a specific workout plan or training sheet assigned within the gym environment.

Practical examples include:

  • Automatically pulling a workout worksheet to display or process in another system.
  • Integrating worksheet data into reporting or member management workflows.
  • Using worksheet details to customize notifications or coaching plans.

Properties

Name Meaning
Show Complete Response If enabled, returns the full raw response from the API instead of just the main data.
ID The unique identifier of the worksheet to retrieve. This is required to specify which worksheet to get.

Output

The node outputs JSON data representing the requested worksheet. The structure typically includes all relevant fields describing the worksheet such as its metadata, associated workouts, exercises, and other details as provided by the GymControl API.

If "Show Complete Response" is enabled, the output will contain the entire API response, which may include additional metadata or status information beyond the worksheet data itself.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the GymControl API.
  • The node expects the base URL of the GymControl instance to be configured in the credentials.
  • Network access to the GymControl API endpoint is necessary.

Troubleshooting

  • Invalid or missing ID: The node requires a valid worksheet ID. Ensure the ID is correct and corresponds to an existing worksheet.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Network issues: Confirm connectivity to the GymControl API URL.
  • Unexpected API responses: Enabling "Show Complete Response" can help debug by showing the full API reply.

Common error messages might include unauthorized access, resource not found, or bad request due to invalid parameters. Checking the worksheet ID and API credentials usually resolves these.

Links and References

Discussion