Step Type: Call API Endpoint

The Call API Endpoint step sends an HTTP request to an API connection and captures the response. This allows you to interact with REST APIs as part of your migration workflow.

When to Use

• To fetch configuration data or lookup values from an API before migration
• To trigger actions on external systems (e.g., creating a user, starting a process)
• To retrieve authentication tokens or session information
• To call custom API endpoints for data not available through standard table access

Configuration

Setting	Description
Connection	The API connection to use (must be an API-type adaptor)
Endpoint	Select a pre-configured endpoint, or specify a custom one
HTTP Method	GET, POST, PUT, PATCH, or DELETE
URL Override	Optionally override the endpoint URL using a formula expression
Inherit Headers	Whether to inherit default headers from the API adaptor configuration
Output Variable	Variable to store the response data

How It Works

1. The step constructs the HTTP request using the connection’s base URL and authentication
2. If a URL override is provided, it replaces the default endpoint URL
3. Headers from the API adaptor are included if “Inherit Headers” is enabled
4. The request is sent and the response is captured
5. The response data is parsed and stored in the configured output variable

Example

To fetch a list of users from a REST API:

1. Create an API connection with the base URL and authentication
2. Add a Call API Endpoint step
3. Set the HTTP method to GET and the endpoint path (e.g., /api/users)
4. Configure an output variable (e.g., user_list) to capture the response
5. Subsequent steps can reference user_list in formulas and mappings