GET
/
core
/
companies
curl --request GET \
  --url https://api.rootfi.dev/v3/companies \
  --header 'api_key: <api-key>'

{
  "data": [
    {
      "activity_log": [
        {
          "activity_type": "COMPANY_CREATED",
          "rootfi_created_at": "2021-08-10T12:00:00Z",
          "rootfi_id": 1,
          "rootfi_updated_at": "2021-08-10T12:00:00Z"
        }
      ],
      "connections": [
        {
          "category": "ACCOUNTING",
          "connection_status": "HEALTHY",
          "integration_type": "QUICKBOOKS",
          "last_synced": "2021-08-10T12:00:00Z",
          "rate_limits": {
            "counters": {
              "concurrent": 0,
              "day": 4,
              "hour": 1,
              "minute": 1
            },
            "lastReset": {
              "day": "2024-01-28T11:00:17.087Z",
              "hour": "2024-01-29T05:10:40.896Z",
              "minute": "2024-01-29T05:10:40.896Z"
            },
            "maxLimits": {
              "concurrent_calls": 10,
              "per_minute": 500
            }
          },
          "rootfi_created_at": "2021-08-10T12:00:00Z",
          "rootfi_id": 1,
          "rootfi_updated_at": "2021-08-10T12:00:00Z",
          "sync_resume_at": "2021-08-10T12:00:00Z",
          "sync_status": "IDLE",
          "tally_last_active_at": "2021-08-10T12:00:00Z",
          "zoho_sub_calls_enabled": true
        }
      ],
      "invite_link": {
        "integration_categories": [
          "ACCOUNTING",
          "CRM"
        ],
        "integrations": [
          "QUICKBOOKS",
          "XERO"
        ],
        "invite_link_id": "1",
        "rootfi_created_at": "2021-08-10T12:00:00Z",
        "rootfi_id": 1
      },
      "name": "Rootfi",
      "rootfi_created_at": "2021-08-10T12:00:00Z",
      "rootfi_id": 1,
      "rootfi_updated_at": "2021-08-10T12:00:00Z"
    }
  ],
  "next": "eyJyb290ZmlfaWQiOjQ0MDA2MX0="
}

Authorizations

api_key
string
headerrequired

Query Parameters

limit
integer | null

The number of objects you want to retrieve

next
string | null

The next page of objects to retrieve

search
string | null

The search string to filter the companies

integrations
string | null

The integration type to filter the companies

categories
string | null

The integration category to filter the companies

status
string | null

The status of the company. Allowed values are HEALTHY, EXPIRED, PENDING, DISCONNECTED, SLEEPING, and DELETED

expand
string | null

The fields to expand in the response

Response

200 - application/json
data
object[]
required

The data of the company endpoint

next
string | null

The next page of objects to retrieve