Skip to main content
POST
Make Passthrough Request

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Body

application/json
method
enum<string>
required

Method of the request

Available options:
CONNECT,
DELETE,
GET,
HEAD,
OPTIONS,
PATCH,
POST,
PUT,
TRACE
Example:

"POST"

path
string
required

Path of the request

Example:

"/employees"

headers
headers · object | null
required

headers of the request

Example:
params
params · object | null

params of the request

Example:
data

Body of the request

Example:
request_format
enum<string> | null
default:JSON

format of the request

Available options:
JSON,
XML,
MULTIPART
Example:

"JSON"

response_format
enum<string> | null
default:JSON

format of the response

Available options:
JSON,
XML,
MULTIPART,
BINARY
Example:

"JSON"

timeout
number | null

timeout of the request

Example:

300

Response

Successful Response