---
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

- ForwardRequest
  - `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.
  - `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.
  - `request_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" }`

## Response `200`

Successful response

- ForwardResponse
  - `headers` object, nullable — 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 — 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 — The HTTP headers that were specified for the forwarded request.
    - `params` object, nullable — The query parameters that were specified for the forwarded request.
    - `data` union — The body that was specified for the forwarded request.
      - string
      - object
      - unknown
      - unknown

---

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