Skip to main content
POST
/
api
/
v1
/
passthrough
Make Passthrough Request
curl --request POST \
  --url https://api.bindbee.dev/api/v1/passthrough \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '
{
  "path": "<string>",
  "headers": {
    "Content-Type": "application/json"
  },
  "params": {
    "a": 1,
    "b": 2
  },
  "data": {
    "a": 1,
    "b": 2
  },
  "request_format": "JSON",
  "response_format": "JSON",
  "timeout": 300
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

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
required

headers of the request

Example:
{ "Content-Type": "application/json" }
​
params
params · object

params of the request

Example:
{ "a": 1, "b": 2 }
​
data

Body of the request

Example:
{ "a": 1, "b": 2 }
​
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
Example:

"JSON"

​
timeout
number | null

timeout of the request

Example:

300

Response

Successful Response