v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB

Management

Request Forwarding

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.

post/forward

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Request body

methodstring required

The HTTP method for the forwarded request. Valid values include: GET , POST , PUT , DELETE , and PATCH.

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

paramsobject nullable

The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.

datastring nullable

The body for the forwarded request. This value must be specified as either a string or a valid JSON object.

request_headersobject 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

Successful response

headersobject nullable

The HTTP headers of the forwarded request's response, exactly as received from the underlying integration's API.

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

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