---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
keyword: [Extend, Orchestration Builder, Orchestrate, Orchestration]
nav: wcp_docs
parent_url: /wcp_docs/
title: >-
Reference: Send Paged HTTP Request
layout: subsection
---
## Purpose
Use this component to make HTTP GET requests to any external URL that you can properly authenticate with and receive paginated responses.
Orchestrate supports TLS v1.3 and can fall back to v1.2 if the endppoint doesn't support 1.3.
## Template Availability
This component is available in these orchestration templates:
- Synchronous
- Asynchronous
- Business Process
- Home Card
- Integration System
## Properties
Provide a meaningful Reference Name for the step as it will appear in your orchestration.
This component uses the GET method only.
The Auth Tab
Use this tab to specify the type of authentication your request uses. You can create authentication types on the Credentials tab in your orchestration's Settings. Types you create there are available from the drop-down menu here.
The Headers Tab
Use this tab to add HTTP headers, providing a name and value for each.
The Query Parameters Tab
Use this tab to add URL query parameters in the form of key/value pairs.
Parameters are appended to the end of the URL request following `?` and separated by `&`.
Note: Don't include a query parameter if your Next Page URI already contains the necessary key/value pair, as duplicating it in the Query Parameters tab can cause malformed URLs that break your pagination logic.
The Pagination Tab
Use this tab in association with the `GET` method to receive paginated API responses. First select the pagination type, Offset or Cursor.
For Offset Pagination, configure these details:
- Limit: the number of items to return in a single page.
- Limit Parameter Name: the query parameter key the API expects to see associated with the limit value. Examples: `$.limit`, `$.per_page`, `$.count`, `$.page_size`.
- Initial Offset: the number of items to skip before pagination begins.
- Offset Parameter Name: the query parameter key the API expects to see associated with the offset value. Examples: `$.offset`, `$.skip`, `$.start`.
- Data Path: the JSON path to the array containing the required results.
- Max Pages: the maximum number of pages to return. When no value is set here, all pages are returned.
- Flatten result: a boolean value that determines whether results are returned in a single dataset whose size is determined by the Max Pages value.
For Cursor Pagination, first select a Cursor Type:
- Cursor token in response body
- Next page URI in response body
- Next page URI in HTTP Link header
For the token option, configure these details:
- Next Page Parameter Name: the query parameter key the API expects to see associated with the next page token. Examples: `$.cursor`, `$.after`, `$.starting_after`.
- Next Page Token Path: the JSON path to the cursor token attribute in the response. Examples: `$.cursor`, `$.marker`.
- Page Size Parameter Name: the query parameter key the API expects to see associated with the page size value. Examples: `$.limit`, `$.per_page`, `$.page_size`.
- Page Size Value: the number of items to return on each page.
- Data Path: the JSON path to the array containing the required results.
- Max Pages: the maximum number of pages to fetch. If no value is provided, all pages are returned.
- Flatten result: a boolean value that determines whether results are returned in a single dataset whose size is determined by the Max Pages value.
For the Next page URI in response body option, configure these details:
- Next Page URI Path: the JSON path to the attribute containing the link to the next page. Examples: `$.links_next`, `$.next_page_url`
- URI Type: Select the check box to indicate the the next page URI is absolute. Clear the check box to indicate that the URI is a partial path that must be appended to the base address.
- Page Size Parameter Name: the query parameter key the API expects to see associated with the page size value. Examples: `$.limit`, `$.per_page`, `$.page_size`.
- Page Size Value: the number of items to return on each page.
- Data Path: the JSON path to the array containing the required results.
- Max Pages: the maximum number of pages to fetch. If no value is provided, all pages are returned.
- Flatten result: a boolean value that determines whether results are returned in a single dataset whose size is determined by the Max Pages value.
For the Next page URI in HTTP Link header option, configure these details:
- Link Relationship Name: the name associated with the `rel` parameter in the Link header, used to identify the URI for the next page. Examples: `self`, `next`.
- Page Size Parameter Name: the query parameter key the API expects to see associated with the page size value. Examples: `$.limit`, `$.per_page`, `$.page_size`.
- Page Size Value: the number of items to return on each page.
- Data Path: the JSON path to the array containing the required results.
- Max Pages: the maximum number of pages to fetch. If no value is provided, all pages are returned.
- Flatten result: a boolean value that determines whether results are returned in a single dataset whose size is determined by the Max Pages value.
Note:
The link Header must strictly adhere to the RFC 5988 standard. Example:
- https://{domain}/api/v1/users?limit=20; rel="self"
- https://{domain}/api/v1/users?limit=20&after=1627500044869_1>; rel="next"
The Settings Tab
Use this tab to configure these request and response details:
- Overall Timeout: The total time allowed for the operation.
- Connect Timeout: The time allowed for a client-server connection to establish.
- Response Timeout: The time allowed for establishing a connection.
- Response Type: The type of response requested.
- Retry Settings: Select a predefined Retry policy. You can create Retry policies on the HTTP Retries tab of your orchestration's Settings.
Select the Advanced Mode check box to reveal these additional settings:
- Polling Settings: Select a HTTP polling configuration that you created in the Orchestration's settings.
- Transfer-Encoding Settings: Select the Chunk encoding check box to send the HTTP request in multiple segments rather than as a single entity. Ensure that your target API supports this configuration before enabling the setting. Although some APIs actively require chunked transfer encoding, not all APIs support it.