Custom API Call → GET
AI-generatedOverview
This node interacts with the XPlanner API, allowing users to perform custom API calls. Specifically, it supports GET and POST operations on any API endpoint under the base URL configured in the credentials. This is useful for scenarios where predefined operations are insufficient, enabling flexible API requests such as fetching user data or posting new records.
Use Case Examples
- Fetching a list of users by specifying the endpoint '/api/v1/users' with a GET operation.
- Sending data to a custom endpoint using a POST operation with a JSON body.
Properties
| Name | Meaning |
|---|---|
| API Endpoint | The path appended to the base URL to form the full API request URL. This is required and must be specified for the custom API call. |
Output
JSON
json- The JSON response returned from the XPlanner API for the requested endpoint and operation.
Dependencies
- Requires an API key credential for XPlanner API authentication, including base URL, client key, and client secret.
Troubleshooting
- Common issues include authentication failures if the API key credentials are incorrect or expired, resulting in errors when fetching the access token.
- Invalid or missing API endpoint paths can cause request failures or unexpected responses.
- If the node is set to continue on fail, errors will be returned in the output JSON under an 'error' property for each failed item.