Passthrough
Get Passthrough Data
- Roadmap
- Security
- Status
- Overview
- Typescript SDK
Accounting
Payments
Ecommerce
Overview
Server Side SDKs
Unified API
Passthrough
Get Passthrough Data
Retrieve passthrough data from integration platforms.
POST
/
core
/
passthrough
api_key
string
*
api_key
Required
string
coregetPassthroughDataRequest · object
*
Required
object
The request object for the getPassthroughData endpoint.
company_id
integer
*
company_id
Required
integer
The ID of the company to retrieve passthrough data for.
Add Example Value
data
coreaxiosRequestConfig · object
*
data
Required
object
The data to send to the integration platform.
method
string
*
method
Required
string
The HTTP method to use.
Add Example Value
path
string
*
path
Required
string
The URL to send the request to.
Add Example Value
headers
object
*
headers
Required
object
The headers to send with the request.
data
object
*
data
Required
object
The data to send with the request.
params
object
*
params
Required
object
The query parameters to send with the request.
curl --request POST \
--url https://api.rootfi.dev/v3/core/passthrough \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1111,
"data": {
"method": "GET",
"path": "/contacts",
"headers": {},
"data": {},
"params": {}
}
}'
{
"data": {
"data": {
"code": 0,
"message": "success",
"contacts": [
{
"contact_id": "3770712000001545104",
"contact_name": "Albert Brown",
"portal_status": "disabled",
"created_time": "2023-10-13T11:44:39+0530",
"created_time_formatted": "13/10/2023",
"last_modified_time": "2023-10-13T11:44:39+0530",
"last_modified_time_formatted": "13/10/2023",
"custom_fields": [],
"custom_field_hash": {},
"ach_supported": false,
"gst_no": "07CEUPK5322M1XX",
"gst_treatment": "business_gst",
"place_of_contact": "DL",
"place_of_contact_formatted": "Delhi",
"has_attachment": false,
"pan_no": "ODSPS1279F"
}
],
"page_context": {
"page": 1,
"per_page": 200,
"has_more_page": false,
"report_name": "Contacts",
"applied_filter": "Status.All",
"custom_fields": [],
"sort_column": "contact_name",
"sort_order": "A"
}
}
}
}
Authorizations
api_key
string
headerrequiredBody
application/json
company_id
integer
requiredThe ID of the company to retrieve passthrough data for.
data
object
requiredThe data to send to the integration platform.
data.method
string
requiredThe HTTP method to use.
data.path
string
requiredThe URL to send the request to.
data.headers
object
requiredThe headers to send with the request.
data.data
object
requiredThe data to send with the request.
data.params
object
requiredThe query parameters to send with the request.
Response
200 - application/json
data
object
requiredThe data returned from the integration platform.
curl --request POST \
--url https://api.rootfi.dev/v3/core/passthrough \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '{
"company_id": 1111,
"data": {
"method": "GET",
"path": "/contacts",
"headers": {},
"data": {},
"params": {}
}
}'
{
"data": {
"data": {
"code": 0,
"message": "success",
"contacts": [
{
"contact_id": "3770712000001545104",
"contact_name": "Albert Brown",
"portal_status": "disabled",
"created_time": "2023-10-13T11:44:39+0530",
"created_time_formatted": "13/10/2023",
"last_modified_time": "2023-10-13T11:44:39+0530",
"last_modified_time_formatted": "13/10/2023",
"custom_fields": [],
"custom_field_hash": {},
"ach_supported": false,
"gst_no": "07CEUPK5322M1XX",
"gst_treatment": "business_gst",
"place_of_contact": "DL",
"place_of_contact_formatted": "Delhi",
"has_attachment": false,
"pan_no": "ODSPS1279F"
}
],
"page_context": {
"page": 1,
"per_page": 200,
"has_more_page": false,
"report_name": "Contacts",
"applied_filter": "Status.All",
"custom_fields": [],
"sort_column": "contact_name",
"sort_order": "A"
}
}
}
}