Get All Companies

curl --request GET \
  --url https://api.rootfi.dev/company/all \
  --header 'api_key: <api-key>'

{
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>",
  "data": {
    "pending_companies": 123,
    "active_companies": 123,
    "data": [
      {
        "integration_type": "ZOHO_BOOKS",
        "status": "HEALTHY",
        "last_synced": "<string>",
        "rate_limits": {},
        "zoho_sub_calls_enabled": true,
        "name": "<string>",
        "sync_enabled": true,
        "invite_link_id": "<string>",
        "integrations": [
          "ZOHO_BOOKS"
        ],
        "last_synced_at": "<string>",
        "jobs": [
          {}
        ],
        "rootfi_id": 123,
        "rootfi_company_id": 123,
        "rootfi_organisation_id": 123,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rate_limit_sleep_time": "<string>",
        "tally_last_active_at": "<string>",
        "metadata": "<string>"
      }
    ]
  }
}

GET

company

all

curl --request GET \
  --url https://api.rootfi.dev/company/all \
  --header 'api_key: <api-key>'

{
  "request_timestamp": "2023-11-07T05:31:56Z",
  "response_timestamp": "2023-11-07T05:31:56Z",
  "request_id": "<string>",
  "data": {
    "pending_companies": 123,
    "active_companies": 123,
    "data": [
      {
        "integration_type": "ZOHO_BOOKS",
        "status": "HEALTHY",
        "last_synced": "<string>",
        "rate_limits": {},
        "zoho_sub_calls_enabled": true,
        "name": "<string>",
        "sync_enabled": true,
        "invite_link_id": "<string>",
        "integrations": [
          "ZOHO_BOOKS"
        ],
        "last_synced_at": "<string>",
        "jobs": [
          {}
        ],
        "rootfi_id": 123,
        "rootfi_company_id": 123,
        "rootfi_organisation_id": 123,
        "rootfi_integration_type": "ZOHO_BOOKS",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rate_limit_sleep_time": "<string>",
        "tally_last_active_at": "<string>",
        "metadata": "<string>"
      }
    ]
  }
}

curl --request GET \
  --url https://api.rootfi.dev/company/all \
  --header 'api_key: <api-key>'

Authorizations

api_key

string

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

offset

integer | null

The index from where you want to start retrieving objects

Response

200 - application/json

The response of the get all companies endpoint.

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

data

FinalCompanyResponse · object

required

The response of the company endpoint

Show child attributes

data.pending_companies

number<double>

required

The Number pending companies

data.active_companies

number<double>

required

The Number active companies

data.data

FinalCompanyData · object[]

required

Show child attributes

data.data.integration_type

enum<string>

required

The integration type of the company

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.status

enum<string>

required

The status of the company

Available options:

HEALTHY,

DISCONNECTED,

EXPIRED,

PENDING

data.data.last_synced

string

required

The last time the company was synced

data.data.rate_limits

object

required

The rate limits of the company

data.data.zoho_sub_calls_enabled

boolean

required

Whether the sub calls are enabled for ZOHO BOOKS or not.

data.data.name

string

required

Name of the company

data.data.sync_enabled

boolean

required

Whether the company is currently syncing with the platform

data.data.invite_link_id

string

required

ID of the invite link in the platform database

data.data.integrations

enum<string>[]

required

Integrations list the company is allowed to connect to

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.last_synced_at

string

required

The last time the company was synced

data.data.jobs

object[]

required

The jobs of the company

data.data.rootfi_id

number<double> | null

The unique ID we assign for that data's information

data.data.rootfi_company_id

number<double> | null

The RootFi designated id for the company

data.data.rootfi_organisation_id

number<double> | null

The RootFi designated id for the organisation

data.data.rootfi_integration_type

enum<string> | null

The accounting platform from which the data is being retrieved

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

WAVE,

ODOO_ACCOUNTING,

NETSUITE,

WAFEQ,

MEKARI_JURNAL,

BUSY,

ROOTFI_SANDBOX,

QOYOD

data.data.rootfi_updated_at

string<date-time> | null

The latest date at which RootFi updated this data

data.data.rootfi_created_at

string<date-time> | null

The date at which RootFi first synced this data

data.data.rate_limit_sleep_time

string | null

The time the company will be rate limited

data.data.tally_last_active_at

string | null

The last time the company was active in tally

data.data.metadata

string | null

Metadata

Get Companies Get Company

⌘I

General

Server Side SDKs

Core API

Unified API

Get All Companies

Authorizations

Query Parameters

Response