Endpoint API

Calls an API endpoint registered in the workspace API Manager. Reuses the configuration (auth, headers) defined in the catalog.

Parameters

Parameter	Type	Required	Variable	Description
endpointId	text	Yes	Yes	Selected API endpoint identifier from the catalog.
endpointPath	text	No	No	Endpoint path (e.g. /api/queries/nodes). Auto-filled on selection.
method	choice (GET, POST, PUT, PATCH, DELETE)	Yes	No	HTTP method for the request.
category	text	No	No	Endpoint category (queries, commands, health, etc.).
description	text	No	No	Endpoint description.
apiKeyConfig	object	No	No	API key configuration for authentication.
requestBody	dynamic value	No	Yes	Request body (for POST, PUT, PATCH methods). Can be a literal or a variable.
headers	array	No	No	HTTP request headers (dynamic key/value pairs).
queryParams	array	No	No	URL query parameters (dynamic key/value pairs).
pathParams	array	No	No	Path parameters auto-extracted from :param patterns in the URL.
timeout	number	No	No	Request timeout in milliseconds.
retryOnError	boolean	No	No	Automatically retry the request on error. (Default: false)
maxRetries	number	No	No	Maximum number of retry attempts on error. (Default: 1, min 1, max 10)

Parameters marked Variable = Yes accept the {{blockName.field}} syntax.

Output

Output variable : apiEndpointResult

{
  "success": false,
  "statusCode": 0,
  "headers": {},
  "body": "...",
  "rawBody": "...",
  "responseTimeMs": 0,
  "contentLength": 0,
  "endpoint": {}
}

Example

Call a pre-configured endpoint.

Input :

{"endpointId": "ep-crm-leads"}

Output :

{"success": true, "statusCode": 200, "headers": {"content-type": "application/json"}, "body": [{"id": 1, "name": "Acme"}], "rawBody": "[{\"id\":1,\"name\":\"Acme\"}]", "responseTimeMs": 245, "contentLength": 32, "endpoint": {"id": "ep-crm-leads", "name": "CRM Leads"}}

Tip

Prefer this block over http_request for frequently used APIs: authentication configuration is centralized in the API Manager.