- Roadmap
- Security
- Status
- Overview
- Typescript SDK
Companies
Invite Links
Sync
Passthrough
Real Time
Webhooks
Accounting
Payments
Ecommerce
Overview
Server Side SDKs
Core API
Unified API
Get Companies
Retrieve all companies from the database.
The number of objects you want to retrieve
The next page of objects to retrieve
The integration type to filter the companies
The integration category to filter the companies
The status of the company. Allowed values are HEALTHY, EXPIRED, PENDING, DISCONNECTED, SLEEPING, and DELETED
The fields to expand in the response
curl --request GET \
--url https://api.rootfi.dev/v3/core/companies \
--header 'api_key: <api-key>'{
"data": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"name": "Rootfi",
"invite_link": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"invite_link_id": "1",
"integrations": [
"QUICKBOOKS",
"XERO"
],
"integration_categories": [
"ACCOUNTING"
]
},
"connections": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"integration_type": "QUICKBOOKS",
"category": "ACCOUNTING",
"connection_status": "HEALTHY",
"sync_status": "IDLE",
"sync_resume_at": "2021-08-10T12:00:00Z",
"last_synced": "2021-08-10T12:00:00Z",
"rate_limits": {
"counters": {
"day": 4,
"hour": 1,
"minute": 1,
"concurrent": 0
},
"lastReset": {
"day": "2024-01-28T11:00:17.087Z",
"hour": "2024-01-29T05:10:40.896Z",
"minute": "2024-01-29T05:10:40.896Z"
},
"maxLimits": {
"per_minute": 500,
"concurrent_calls": 10
}
},
"sync_config": {
"data_model": "ACCOUNTS",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
}
},
"tally_last_active_at": "2021-08-10T12:00:00Z",
"zoho_sub_calls_enabled": true
}
],
"activity_log": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"activity_type": "COMPANY_CREATED"
}
]
}
],
"next": "eyJyb290ZmlfaWQiOjQ0MDA2MX0="
}Authorizations
Query Parameters
The number of objects you want to retrieve
The next page of objects to retrieve
The integration type to filter the companies
The integration category to filter the companies
The status of the company. Allowed values are HEALTHY, EXPIRED, PENDING, DISCONNECTED, SLEEPING, and DELETED
The fields to expand in the response
Response
The data of the company endpoint
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
Name of the company
Unique identifier in your system.
ID of the invite link in the platform database
ID of the company in the platform database
The date and time the company was created in the platform database
ID of the invite link in the platform database
The integration type of the invite link
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, NETSUITE, WAVE, ODOO_ACCOUNTING, WAFEQ, MEKARI_JURNAL, BUSY, QOYOD, STRIPE, RAZORPAY, PAYPAL, SHOPIFY, BIG_COMMERCE, WOO_COMMERCE The integration category of the invite link
PAYMENTS, ACCOUNTING, ECOMMERCE Connection details of the company
ID of the company in the platform database
The date and time the company was created in the platform database
The date and time the company was updated in the platform database
The integration type of the connection
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, NETSUITE, WAVE, ODOO_ACCOUNTING, WAFEQ, MEKARI_JURNAL, BUSY, QOYOD, STRIPE, RAZORPAY, PAYPAL, SHOPIFY, BIG_COMMERCE, WOO_COMMERCE The integration category of the connection
PAYMENTS, ACCOUNTING, ECOMMERCE The status of the connection
HEALTHY, DISCONNECTED, EXPIRED, PENDING The status of the sync
IDLE, FETCHING, SLEEPING, PARSING, RUNNING The date and time the sync will resume
The date and time the connection was last synced
The rate limits of the connection
The counters of the rate limit
The date and time the rate limit was last reset
The max limits of the rate limit
The date and time the connection was last active
The status of the zoho sub calls
The sync configuration of the connection
The status of the sync configuration
The interval of the sync configuration
The frequency of the sync configuration
DAILY, WEEKLY, MONTHLY, YEARLY The data model of the sync configuration
ACCOUNTS, BANK_ACCOUNTS, BILLS, BILL_PAYMENTS, COMPANY_INFO, CONTACTS, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, DOCUMENTS, EXPENSES, INVOICES, INVOICE_PAYMENTS, ITEMS, LINE_ITEMS, TAX_RATES, JOURNAL_ENTRIES, BANK_TRANSACTIONS, JOURNAL_LINES, PURCHASE_ORDERS, SALES_ORDERS, PHONE_NUMBERS, ADDRESSES, EXTERNAL_LINKS, CONTACT_PERSONS, INCOME_STATEMENT, BALANCE_SHEET, TRACKING_CATEGORIES, CASH_FLOW_STATEMENT, CURRENCIES, PAYMENT_CUSTOMERS, PAYMENT_INVOICES, PAYMENT_LINE_ITEMS, PAYMENT_ITEMS, PAYMENT_ORDERS, PAYMENT_TAX_RATES, PAYMENT_DISPUTES, PAYMENT_PAYMENTS, PAYMENT_REFUNDS, PAYMENT_PAYMENT_LINKS, PAYMENT_PAYOUTS, PAYMENT_ADDRESSES, PAYMENT_PHONE_NUMBERS, PAYMENT_EXTERNAL_LINKS, PAYMENT_TRANSACTIONS, PAYMENT_BALANCES, ECOMMERCE_ORDERS, ECOMMERCE_CUSTOMERS, ECOMMERCE_PRODUCTS, ECOMMERCE_LINE_ITEMS The scope access of the sync configuration
The access of the scope
The access of the scope
The access of the scope
The access of the scope
The raw_data fields to fetch during sync
Activity log of the company
ID of the company in the platform database
The date and time the company was created in the platform database
The date and time the company was updated in the platform database
The type of activity
ORG_CREATED, USER_CREATED, INVITE_LINK_CREATED, COMPANY_CREATED, CONNECTION_CREATED, CONNECTION_EXPIRED, CONNECTION_DISCONNECTED, USER_DELETED, COMPANY_DELETED, CONNECTION_DELETED The next page of objects to retrieve
curl --request GET \
--url https://api.rootfi.dev/v3/core/companies \
--header 'api_key: <api-key>'{
"data": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"name": "Rootfi",
"invite_link": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"invite_link_id": "1",
"integrations": [
"QUICKBOOKS",
"XERO"
],
"integration_categories": [
"ACCOUNTING"
]
},
"connections": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"integration_type": "QUICKBOOKS",
"category": "ACCOUNTING",
"connection_status": "HEALTHY",
"sync_status": "IDLE",
"sync_resume_at": "2021-08-10T12:00:00Z",
"last_synced": "2021-08-10T12:00:00Z",
"rate_limits": {
"counters": {
"day": 4,
"hour": 1,
"minute": 1,
"concurrent": 0
},
"lastReset": {
"day": "2024-01-28T11:00:17.087Z",
"hour": "2024-01-29T05:10:40.896Z",
"minute": "2024-01-29T05:10:40.896Z"
},
"maxLimits": {
"per_minute": 500,
"concurrent_calls": 10
}
},
"sync_config": {
"data_model": "ACCOUNTS",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
}
},
"tally_last_active_at": "2021-08-10T12:00:00Z",
"zoho_sub_calls_enabled": true
}
],
"activity_log": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"activity_type": "COMPANY_CREATED"
}
]
}
],
"next": "eyJyb290ZmlfaWQiOjQ0MDA2MX0="
}