1. Tasks
  2. API Call

Tasks

API Call

The API Call task is utilized to interact with an external API, enabling the retrieval of data that can be subsequently utilized in subsequent tasks.

Basic usage

loading...

Parameters

apiurl

required
string

The endpoint that the task will invoke. If there are any query strings or URL parameters required, they should be specified here.


method

optional
string

The HTTP method to be used for the API call.

Default: GET


headers

optional
object

Any headers that you wish to include in the request.

Default:

loading...

body

optional
object

Any body that you wish to include in the request.


timeout

optional
number

The seconds after which the apicall will time out.

Default: 10

Result

loading...

Properties

apiresult.status

integer

The status code indicating the outcome of the API call.


apiresult.statusText

string

A textual description of the result status.


apiresult.body

integer

Contains the body of the API result, providing the actual data retrieved from the external API.

Examples

These are some more complex examples

Request with body

Include a body in your apicall request

loading...

Request with headers

Include custom headers in your apicall request

loading...