SmartSuite icon

SmartSuite

Interact with SmartSuite API

Actions21

API Request → GET

AI-generated

Overview

This node performs a GET API request to the SmartSuite REST API. It allows users to specify a relative URL path, add query parameters, headers, and optionally include a request body. This is useful for making custom API calls to SmartSuite endpoints that may not be covered by predefined operations, enabling flexible interaction with the SmartSuite platform.

Use Case Examples

  1. Fetching a list of solutions by specifying the URL '/solutions/' and adding query parameters for pagination.
  2. Retrieving specific records by constructing a GET request with custom headers and query parameters.

Properties

Name Meaning
URL The relative path to the SmartSuite API endpoint to send the GET request to, relative to 'app.smartsuite.com/api/v1'.
Send Query Parameters Whether to include query parameters in the URL of the GET request.
Specify Query Parameters Choose how to specify query parameters, either using individual fields or raw JSON.
Query Parameters A collection of name-value pairs to be added as query parameters to the URL when 'Specify Query Parameters' is set to fields.
Query Parameters (JSON) Raw JSON string representing query parameters when 'Specify Query Parameters' is set to JSON.
Send Headers Whether to include HTTP headers in the GET request.
Specify Headers Choose how to specify headers, either using individual fields or raw JSON.
Header Parameters A collection of name-value pairs to be added as HTTP headers when 'Specify Headers' is set to fields.
Headers (JSON) Raw JSON string representing headers when 'Specify Headers' is set to JSON.
Send Body Whether to include a request body in the GET request (rare for GET but supported).
Specify Body Choose how to specify the request body, either using individual fields or raw JSON.
Body Parameters A collection of name-value pairs to be included in the request body when 'Specify Body' is set to fields.
Body (JSON) Raw JSON string representing the request body when 'Specify Body' is set to JSON.

Output

JSON

  • responseData - The JSON response data returned from the SmartSuite API request.

Dependencies

  • SmartSuite API authentication credential

Troubleshooting

  • Ensure the URL path is correctly specified relative to 'app.smartsuite.com/api/v1'.
  • If query parameters or headers are included, verify their format and correctness, especially when using raw JSON.
  • Check that the API authentication credential is valid and has the necessary permissions.
  • Common error messages may include authentication failures, invalid URL paths, or malformed query/header parameters. Verify these inputs to resolve errors.

Links

Discussion