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

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.

Authorizations

api_key
string
headerrequired

Path Parameters

invite_link_id
string
required

The ID of the invite link you want to retrieve.

Response

200 - application/json
request_id
string
required

The unique ID of the request

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

data
object
required