Call HTTP Get

The Call HTTP Get component allows users to make a REST API GET request to a specified URL. This tool is useful for retrieving data from external services, fetching resources, or integrating with APIs that require query parameters and custom headers.

To use this component, users need to provide the target URL, along with optional request headers and parameters. The response format can be specified as JSON, raw, or plain text, depending on the expected output. As part of the Custom Logic category, this tool helps automate API interactions efficiently.

Overview

The Call HTTP Get component allows you to make REST API GET requests from your Pipeline Builder workflows. This component simplifies the process of retrieving data from external APIs and integrating it into your pipeline, with support for custom headers, parameters, and different response formats.

How to use

Key Terms

When to Use

• When you need to retrieve data from external REST APIs or web services.

• When you want to fetch real-time information to incorporate into your pipeline.

• When you need to integrate with third-party systems that expose GET endpoints.

• When you want to validate the availability or status of an external service.

Component Configuration

Required Inputs

Optional Input

How It Works

1. The component constructs an HTTP GET request using the provided URL.

2. Default headers are applied (content-type: application/JSON, Accept: /, Connection: keep-alive)

3. If custom headers are provided, they are merged with the default headers.

4. Request parameters are added to the URL as query parameters.

5. The HTTP request is sent to the specified endpoint.

6. The response is processed according to the specified response format.

7. Additional response metadata (status code, headers, etc.) is collected.

8. All response data is returned as component output for use in subsequent pipeline steps.

Example Use Case

Scenario: Retrieving user data from an external API to populate a dashboard.

Configuration:

• URL: <https://dummyjson.com/users>

• Request Headers: Default headers (no custom headers needed)

• Request Params: No custom parameters

• Response Format: JSON

Process:

1. The component sends a GET request to <https://dummyjson.com/users>.

2. The API returns a JSON response containing user data.

3. The component processes the response as JSON.

4. The response data is mapped to the output variable "dummyUsers".

5. Subsequent pipeline components can use this data for display or further processing.

Component Configuration Example:

Output Format

The component returns a comprehensive result object containing both the API response and metadata about the request. The "response" field content varies based on your selected Response Format:

Regardless of the Response Format, the result object contains:

• response: The actual data returned by the API (format depends on the Response Format setting).

• status_code: The HTTP status code returned.

• cookies: Any cookies set by the server.

• elapsed: How long the request took to complete.

• encoding: The character encoding of the response.

• headers: Headers returned by the server.

• ok: Boolean indicating if the request was successful (status code 200-299).

• reason: The HTTP reason phrase corresponds to the status code.

Example output for a successful request:

{"response":{"users":[{"id":1,"firstName":"John","lastName":"Doe","email":"john.doe@example.com"},{"id":2,"firstName":"Jane","lastName":"Smith","email":"jane.smith@example.com"}],"total":2},"status_code":200,"cookies":{},"elapsed":"0:00:00.125678","encoding":"utf-8","headers":{"Content-Type":"application/json","Date":"Sat, 05 Apr 2025 12:00:00 GMT"},"ok":true,"reason":"OK"}

Best Practices

Use appropriate response format - Choose 'JSON' for structured data, 'text' for plain text responses, and 'raw' only when you need the raw binary response

Troubleshooting