Get Invite Link

Retrieve a single invite link from the database.

GET /core/invite_links/{invite_link_id}

Get Invite Link

cURL

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

import requests

url = "https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/core/invite_links/{invite_link_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "rootfi_id": 1,
    "rootfi_created_at": "2021-08-10T12:00:00Z",
    "rootfi_updated_at": "2021-08-10T12:00:00Z",
    "invite_link_id": "1",
    "integrations": [
      "XERO"
    ],
    "integration_categories": [
      "ACCOUNTING"
    ],
    "company": {
      "rootfi_id": 1,
      "rootfi_created_at": "2021-08-10T12:00:00Z",
      "rootfi_updated_at": "2021-08-10T12:00:00Z",
      "name": "RootFi"
    },
    "connections": [
      {
        "rootfi_id": 1,
        "rootfi_created_at": "2021-08-10T12:00:00Z",
        "rootfi_updated_at": "2021-08-10T12:00:00Z",
        "integration_type": "XERO",
        "status": "HEALTHY",
        "sync_status": "IDLE",
        "rate_limits": {
          "counters": {
            "day": 4,
            "hour": 1,
            "minute": 1,
            "concurrent": 0
          },
          "lastReset": {
            "day": "2024-01-28T11:00:17.087Z",
            "hour": "2024-01-29T05:10:40.896Z",
            "minute": "2024-01-29T05:10:40.896Z"
          },
          "maxLimits": {
            "per_minute": 500,
            "concurrent_calls": 10
          }
        },
        "sync_config": [
          {
            "data_model": "ACCOUNTS",
            "enabled": true,
            "frequency": "DAILY",
            "interval": 1,
            "scope_access": {
              "READ": true,
              "CREATE": true,
              "UPDATE": true,
              "DELETE": true
            },
            "category": "ACCOUNTING",
            "sync_from": "2023-01-01T00:00:00Z"
          }
        ],
        "category": "ACCOUNTING"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

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 · header · required

Path Parameters

invite_link_id · string · required

The ID of the invite link to retrieve

Response

200

application/json

The data of the invite link endpoint

data · coreInviteLinkData · object · required

The data of the invite link endpoint

Show child attributes