The HTTP Request node is one of the most versatile nodes in n8n. It allows you to make HTTP requests to query data from any app or service with a REST API.
When using this node, you're creating a REST API call. You need some understanding of basic API terminology and concepts.
Examples and templates
For usage examples and templates to help you get started, refer to n8n's HTTP Request integrations page.
Select the method to use for the request:
Enter the endpoint you want to use.
n8n recommends using the Predefined Credential Type option when it's available. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.
Select Predefined Credential Type. This allows you to perform custom operations, without additional authentication setup. For example, n8n has an Asana node, and supports using your Asana credentials in the HTTP Request node. Refer to Custom API operations for more information.
Select Generic Credential Type to set up authentication using one of the following methods:
- Basic Auth
- Custom Auth
- Digest Auth
- Header Auth
- OAuth1 API
- OAuth2 API
- Query Auth
Refer to HTTP request credentials for more information setting up each credential type.
Parameters, headers, and body#
You can choose to send additional information with your request. The data you need to send depends on the API you're interacting with, and the type of request you're making. Refer to your service's API documentation for detailed guidance.
- Send Query Parameters: include query parameters. Query parameters are usually used as filters or searches on your query.
- Send Headers: include request headers. Headers contain metadata about your request.
- Send Body: send additional information in the body of your request.
Select Add Option to view and select these options.
- Batching: control how to batch large responses.
- Ignore SSL Issues: download the response even if SSL validation isn't possible.
- Redirects: choose whether to follow redirects. Enabled by default.
- Response: provide settings about the expected API response.
- Pagination: handle query results that are too big for the API to return in a single call.
- Proxy: use this if you need to specify an HTTP proxy.
- Timeout: set a timeout for the request.
Use this option to paginate results.
Inspect the API data first
Some options for pagination require knowledge of the data returned by the API you're using. Before setting up pagination, either check the API documentation, or do an API call without pagination, to see the data it returns.
What is pagination?
Pagination means splitting a large set of data into multiple pages. The amount of data on each page depends on the limit you set.
For example, you make an API call to an endpoint called
/users. The API wants to send back information on 300 users, but this is too much data for the API to send in one response.
If the API supports pagination, you can incrementally fetch the data. To do this, you call
/users with a pagination limit, and a page number or URL to tell the API which page to send. In this example, say you use a limit of 10, and start from page 0. The API sends the first 10 users in its response. You then call the API again, increasing the page number by 1, to get the next 10 results.
Configure the pagination settings:
- Pagination Mode:
- Off: turn off pagination.
- Update a Parameter in Each Request: use this when you need to dynamically set parameters for each request.
- Response Contains Next URL: use this when the API response includes the URL of the next page. Use an expression to set Next URL.
For example setups, refer to HTTP Request node cookbook | Pagination.
n8n provides built-in variables for working with HTTP node requests and responses when using pagination:
||The pagination count. Tracks how many pages the node has fetched.|
||The request object sent by the HTTP node.|
||The response object from the HTTP call. Includes
Different APIs implement pagination in different ways. Check the API documentation for the API you're using for details. You need to find out things like:
- Does the API provide the URL for the next page?
- Are there API-specific limits on page size or page number?
- The structure of the data that the API returns.
Import curl command#
curl is a command line tool and library for transferring data with URLs.
You can use curl to call REST APIs. If the API documentation of the service you want to use provides curl examples, you can copy them out of the documentation and into n8n to configure the HTTP Request node.
Import a curl command:
- Select Import cURL command.
- Paste in your curl command.
- Select Import. n8n loads the request configuration into the node fields. This overwrites any existing configuration.