Skip to main content
POST
/
core
/
real_time
Get Real time Data
curl --request POST \
  --url https://api.rootfi.dev/v3/core/real_time \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1111,
  "data_model": "COMPANY_INFO",
  "variables": {
    "per_page": 100,
    "page": 1
  }
}
'
{
  "data": {
    "platform_id": "1234567890123456789",
    "name": "RootFi",
    "legal_name": "RootFi Inc.",
    "base_currency": "INR",
    "fiscal_start_at": "2023-12-31T00:00:00.000Z",
    "org_created_at": "2023-12-31T00:00:00.000Z",
    "registration_number": "07CEUPK5322M1ZX",
    "tax_number": "ODSPS1279G",
    "addresses": {
      "data": [
        {
          "platform_id": "3770712000001721013_CONTACTS_3770712000001721005_SHIPPING",
          "type": "SHIPPING",
          "data_model": "CONTACTS",
          "data_model_id": "3770712000001721005",
          "street": "21 street house",
          "locality": "Koramanager",
          "city": "Hyderabad",
          "state": "Bengalore",
          "country": "India",
          "pincode": "500045",
          "updated_at": "2023-11-05T00:00:00.000Z"
        }
      ]
    },
    "external_links": {
      "data": [
        {
          "platform_id": "CONTACTS_3770712000001721005_WEBSITE",
          "data_model": "CONTACTS",
          "data_model_id": "3770712000001721005",
          "link": "https://www.rootfi.dev",
          "type": "WEBSITE",
          "updated_at": "2023-11-05T00:00:00.000Z"
        }
      ]
    },
    "phone_numbers": {
      "data": [
        {
          "platform_id": "CONTACTS_3770712000001721005_MOBILE",
          "data_model": "CONTACTS",
          "data_model_id": "3770712000001721005",
          "number": "+919*********",
          "type": "MOBILE",
          "updated_at": "2023-11-05T00:00:00.000Z"
        }
      ]
    },
    "updated_at": "2023-12-31T00:00:00.000Z"
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

The request object for the getRealTimeData endpoint.

​
company_id
integer
required

The ID of the company to retrieve real_time data for.

Example:

1111

​
data_model
string
required

The data model to retrieve real_time data for.

Example:

"COMPANY_INFO"

​
variables
object
required

The variables to retrieve real_time data for.

Response

The response object for the getRealTimeData endpoint.

​
data
object
required

The data returned from the integration platform.