> For the complete documentation index, see [llms.txt](https://docs.cosmocloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cosmocloud.io/flow-builder/node-types/external-nodes/api-call.md).

# API Call

**API call** node is used to retrieve data from external sources, manipulate data, integrate different software systems, automate tasks, and customise applications by accessing and interacting with external services or resources .&#x20;

### Properties Panel

#### General&#x20;

<table data-full-width="true"><thead><tr><th width="370">Field</th><th width="379">Description</th><th width="114">Required</th><th>Depends on</th></tr></thead><tbody><tr><td>Node name</td><td><a href="/pages/jJ1qO0Ju8d7VFyPB2Jy3"><mark style="color:blue;"><strong>Checkout Node name</strong></mark></a></td><td>true</td><td>_</td></tr><tr><td>URL</td><td>A web address that specifies the location of a resource on the internet.</td><td>true</td><td>_</td></tr><tr><td>Method</td><td>API call method for the specified url</td><td>true</td><td>_</td></tr><tr><td>JSON Payload</td><td>Payload data for the API call</td><td>false</td><td>Method is 'POST'</td></tr><tr><td>Request headers</td><td>Headers for the API call if needed</td><td>false</td><td>-</td></tr></tbody></table>

#### Authentication

<table data-full-width="true"><thead><tr><th width="195">Field</th><th width="246">Description</th><th>Required</th><th>Default</th><th>Depends on</th></tr></thead><tbody><tr><td>Type</td><td>Authentication type (if API is authenticated)</td><td>false</td><td>No Auth</td><td>_</td></tr><tr><td>Username</td><td>Username for basic/digest auth</td><td>true</td><td>_</td><td>Basic Auth / Digest Auth</td></tr><tr><td>Password</td><td>Password for basic/digest auth</td><td>true</td><td>_</td><td>Basic Auth / Digest Auth</td></tr><tr><td>Header prefix</td><td>prefix used in the Authorization header of API request</td><td>false</td><td>Bearer</td><td>Bearer Token</td></tr><tr><td>Token</td><td>Token for API call</td><td>true</td><td>_</td><td>Bearer Token</td></tr><tr><td>Key</td><td>unique identifier provided to access an API</td><td>true</td><td>_</td><td>API Key</td></tr><tr><td>Value</td><td>corresponding secret or token associated with provided key</td><td>true</td><td>_</td><td>API Key</td></tr><tr><td>Add to</td><td>Headers or Params</td><td>true</td><td>_</td><td>API Key</td></tr></tbody></table>

### Returns

* `body` - The result of the API call at runtime. You can access this using Magical Autocomplete (eg. `$.<node_name>.body`) in any node below this node.
* `statusCode` - Status of API call at runtime to check any possible errors. You can access this using Magical Autocomplete (eg. `$.<node_name>.statusCode`) in any node below this node.
