---
title: "Request Forwarding"
method: POST
path: "/forward"
tags: ["Management"]
---

# Request Forwarding

`POST /forward`

The Forward API allows you to make direct requests to an employment system. If Finch's unified API
doesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull
data models directly against an integration's API.

## Headers

- `Finch-API-Version` string, date, required

## Request body

- object — Forward Request Body
  - `method` string, required — The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
  - `route` string, required — The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.
  - `headers` object, nullable — The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
  - `params` object, nullable — The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.
  - `data` string, nullable — The body for the forwarded request. This value must be specified as either a string or a valid JSON object.

## Response `200`

Successful response

- object
  - `headers` object, nullable, required — The HTTP headers of the forwarded request's response, exactly as received from the underlying integration's API.
  - `statusCode` integer, required — The HTTP status code of the forwarded request's response, exactly received from the underlying integration's API. This value will be returned as an integer.
  - `data` string, nullable, required — A string representation of the HTTP response body of the forwarded request's response received from the underlying integration's API. This field may be null in the case where the upstream system's response is empty.
  - `request` object, required — An object containing details of your original forwarded request, for your ease of reference.
    - `method` string, required — The HTTP method that was specified for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
    - `route` string, required — The URL route path that was specified for the forwarded request.
    - `headers` object, nullable, required — The specified HTTP headers that were included in the forwarded request. If no headers were specified, this will be returned as `null`.
    - `params` object, nullable, required — The query parameters that were included in the forwarded request. If no query parameters were specified, this will be returned as `null`.
    - `data` string, nullable, required — The body that was specified for the forwarded request. If a value was not specified in the original request, this value will be returned as null ; otherwise, this value will always be returned as a string.

## Changes

- **2025-04-22** `46640c1b4688` — 1 info
  - the endpoint scheme security `bearerAuth` was added to the API

[Change history](https://skmtc.dev/finch-api/apis/api-reference/changes/forward/post.md)

---

[API](https://skmtc.dev/finch-api/apis/api-reference.md) · [All operations](https://skmtc.dev/finch-api/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/finch-api/api-reference/revisions/e8b684dbd61d/schema)