GET
/
core
/
invite_links
/
{invite_link_id}
curl --request GET \
  --url https://api.rootfi.dev/v3/core/invite_links/{invite_link_id} \
  --header 'api_key: <api-key>'
{
  "data": {
    "company": {
      "name": "RootFi",
      "rootfi_id": 1
    },
    "connections": [
      {
        "category": "ACCOUNTING",
        "integration_type": "XERO",
        "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_id": 1,
        "status": "HEALTHY",
        "sync_status": "IDLE"
      }
    ],
    "integration_categories": [
      "ACCOUNTING"
    ],
    "integrations": [
      "XERO"
    ],
    "invite_link_id": "1"
  }
}

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 to retrieve

Response

200 - application/json
data
object
required

The data of the invite link endpoint