GET
/
invite_link
/
{invite_link_id}
curl --request GET \
  --url https://api.rootfi.dev/invite_link/{invite_link_id} \
  --header 'api_key: <api-key>'

{
  "data": {
    "rootfi_id": 123,
    "rootfi_created_at": "2021-01-01T00:00:00Z",
    "rootfi_updated_at": "2021-01-01T00:00:00Z",
    "rootfi_company_id": 1234,
    "rootfi_organisation_id": 12,
    "metadata": null,
    "invite_link_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b",
    "integrations": [
      "ZOHO_BOOKS"
    ],
    "Companies": {
      "rootfi_id": 1212,
      "rootfi_created_at": "2021-01-01T00:00:00Z",
      "rootfi_updated_at": "2021-01-01T00:00:00Z",
      "rootfi_company_id": 1234,
      "rootfi_organisation_id": 12,
      "name": "Rootfi Test Company",
      "sync_enabled": true,
      "Connections": [
        {
          "rootfi_id": "1234_ZOHO_BOOKS",
          "integration_type": "ZOHO BOOKS",
          "rootfi_company_id": 123,
          "status": "HEALTHY"
        }
      ],
      "Organisation": {
        "rootfi_id": 123,
        "name": "Test Organisation",
        "Integrations": [
          {
            "rootfi_id": null,
            "integration_type": "ZOHO BOOKS",
            "is_disabled": false
          }
        ],
        "sync_config": [
          {
            "enabled": true,
            "interval": 2,
            "frequency": "DAILY",
            "data_model": "ACCOUNTS",
            "initial_fetch": true
          }
        ]
      }
    }
  },
  "request_timestamp": "2021-01-01T00:00:00Z",
  "response_timestamp": "2021-01-01T00:00:00Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

An invite link contains API requests for generating and managing invite links, which can be used to connect end users to their preferred accounting platforms.

curl --request GET \
  --url https://api.rootfi.dev/invite_link/{invite_link_id} \
  --header 'api_key: <api-key>'

Authorizations

​
api_key
string
header
required

Path Parameters

​
invite_link_id
string
required

The ID of the invite link you want to retrieve.

Response

200 - application/json

Response object for the get one invite link endpoint.

​
request_timestamp
string
required

The time at which the request was received by the server

​
response_timestamp
string
required

The time at which the response was sent by the server

​
request_id
string
required

The unique ID of the request

​
data
object
required