Get Invite Links

GET

core

invite_links

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

{
  "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"
        }
      ]
    }
  ],
  "next": "https://api.fern.com/core/invite_links?limit=1&next=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

header

required

Query Parameters

limit

integer | null

The number of objects you want to retrieve

integer | null

The next page of objects to retrieve

expand

string | null

The fields to expand. Allowed values are connections

Response

200

application/json

The data of the invite link endpoint

data

object[]

required

The data of the invite link endpoint

data.rootfi_id

integer

required

The unique ID we assign for that data's information

data.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.invite_link_id

string

required

The ID of the invite link

Example:

"1"

data.integrations

enum<string>[]

required

The integrations of the invite link

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

NETSUITE,

WAVE,

ODOO_ACCOUNTING,

WAFEQ,

MEKARI_JURNAL,

BUSY,

QOYOD,

STRIPE,

RAZORPAY,

PAYPAL,

SHOPIFY,

BIG_COMMERCE,

WOO_COMMERCE,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.integration_categories

enum<string>[]

required

The integration categories of the invite link

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

data.company

object

required

The company of the invite link

data.connections

object[] | null

The connections of the invite link

The data of the connection endpoint

data.connections.rootfi_id

integer

required

The unique ID we assign for that data's information

data.connections.rootfi_created_at

string

required

The date at which RootFi first synced this data

data.connections.rootfi_updated_at

string

required

The latest date at which RootFi updated this data

data.connections.integration_type

enum<string>

required

The integration type of the connection

Available options:

ZOHO_BOOKS,

QUICKBOOKS_SANDBOX,

QUICKBOOKS,

XERO,

TALLY,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

MS_DYNAMICS_365,

SAGE_ZA_CLOUD_ACCOUNTING,

MYOB_BUSINESS,

NETSUITE,

WAVE,

ODOO_ACCOUNTING,

WAFEQ,

MEKARI_JURNAL,

BUSY,

QOYOD,

STRIPE,

RAZORPAY,

PAYPAL,

SHOPIFY,

BIG_COMMERCE,

WOO_COMMERCE,

HUBSPOT,

SALESFORCE,

PIPEDRIVE,

ZOHO_CRM

data.connections.status

enum<string>

required

The status of the connection

Available options:

HEALTHY,

DISCONNECTED,

EXPIRED,

PENDING

data.connections.sync_status

enum<string>

required

The sync status of the connection

Available options:

IDLE,

FETCHING,

SLEEPING,

PARSING,

RUNNING

data.connections.rate_limits

object

required

The rate limits of the connection

data.connections.category

enum<string>

required

The category of the connection

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

data.connections.sync_config

object[] | null

The sync configuration of the connection

data.connections.sync_config.enabled

boolean

required

The status of the sync configuration

Example:

true

data.connections.sync_config.interval

integer

required

The interval of the sync configuration

Example:

1

data.connections.sync_config.frequency

enum<string>

required

The frequency of the sync configuration

Available options:

DAILY,

WEEKLY,

MONTHLY,

YEARLY

data.connections.sync_config.data_model

enum<string>

required

The data model of the sync configuration

Available options:

ACCOUNTS,

BANK_ACCOUNTS,

BILLS,

BILL_PAYMENTS,

COMPANY_INFO,

CONTACTS,

BILL_CREDIT_NOTES,

INVOICE_CREDIT_NOTES,

DOCUMENTS,

EXPENSES,

INVOICES,

INVOICE_PAYMENTS,

ITEMS,

LINE_ITEMS,

TAX_RATES,

JOURNAL_ENTRIES,

BANK_TRANSACTIONS,

JOURNAL_LINES,

PURCHASE_ORDERS,

SALES_ORDERS,

PHONE_NUMBERS,

ADDRESSES,

EXTERNAL_LINKS,

CONTACT_PERSONS,

INCOME_STATEMENT,

BALANCE_SHEET,

TRACKING_CATEGORIES,

CASH_FLOW_STATEMENT,

CURRENCIES,

PAYMENT_CUSTOMERS,

PAYMENT_INVOICES,

PAYMENT_LINE_ITEMS,

PAYMENT_ITEMS,

PAYMENT_ORDERS,

PAYMENT_TAX_RATES,

PAYMENT_DISPUTES,

PAYMENT_PAYMENTS,

PAYMENT_REFUNDS,

PAYMENT_PAYMENT_LINKS,

PAYMENT_PAYOUTS,

PAYMENT_ADDRESSES,

PAYMENT_PHONE_NUMBERS,

PAYMENT_EXTERNAL_LINKS,

PAYMENT_TRANSACTIONS,

PAYMENT_BALANCES,

ECOMMERCE_ORDERS,

ECOMMERCE_CUSTOMERS,

ECOMMERCE_PRODUCTS,

ECOMMERCE_LINE_ITEMS,

CRM_CONTACTS,

CRM_COMPANIES,

CRM_DEALS,

CRM_LEADS,

CRM_NOTES,

CRM_PIPELINES,

CRM_STAGES,

CRM_ACTIVITIES,

CRM_TASKS,

CRM_USERS,

CRM_EXTERNAL_LINKS,

CRM_PHONE_NUMBERS,

CRM_ADDRESSES

data.connections.sync_config.category

enum<string>

required

The category of the datamodel

Available options:

ACCOUNTING,

PAYMENTS,

CRM,

ECOMMERCE,

CUSTOM

data.connections.sync_config.scope_access

object

required

The scope access of the sync configuration

data.connections.sync_config.sync_from

string | null

The date from which the data should be synced. If not provided, it will sync all historical data.

data.connections.sync_config.custom_fields

string[] | null

The custom field names to fetch during syncing (for Netsuite, Hubspot only)

string | null

The next page of objects to retrieve

Delete a company Get All Invite Links

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

{
  "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"
        }
      ]
    }
  ],
  "next": "https://api.fern.com/core/invite_links?limit=1&next=1"
}

General

Server Side SDKs

Core API

Unified API

Get Invite Links

Authorizations

Query Parameters

Response