Authorizations
Headers
ID of the integration you want to interact with.
Path Parameters
The ID of the tool whose passthrough API you want to call (e.g., personio).
The ID of the passthrough API you want to call (some tools provide multiple). Check the endpoint description for a list of all available APIs.
Body
POST /passthrough/:tool/:api Request body
The HTTP method (e.g., GET) of the request.
GET, POST, DELETE, PUT, PATCH The path of the endpoint you want to call. We automatically prepend the base URL of the API (all base URLs are documented in the endpoint description).
The headers to send with the request. Note that we automatically supply any authentication-related headers.
The query parameters to send in addition to the ones in the path.
The data to submit as part of the request body. This can either be an array or object (in which case we will forward it as JSON) or a string (in which case we will forward it raw).
If set to true, the response will be returned as a base64-encoded string. This is useful for binary data (e.g., PDFs).
Custom options interpreted by the passthrough API adapter you've selected. These options are not documented right now as they're only for very advanced use cases.
Response
POST /passthrough/:tool/:api Positive response
"success"{
"url": "https://api.personio.de/v1/company/employees",
"status": 200,
"headers": { "content-type": "application/json" },
"data": {
"success": true,
"data": [
{
"id": 123,
"first_name": "John",
"last_name": "Doe"
}
]
}
}These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.