Account2

AccountControllerV25

AccountingTransaction1

AccountingTransactionControllerV21

Aging2

AgingControllerV22

Attachment2

AttachmentControllerV22

Bank6

BankControllerV213

Bill7

BillControllerV213

Budget1

Businesses12

BusinessValuation1

BusinessValuationControllerV21

Connection2

ConnectionControllerV22

ContactControllerV21

Credit2

CreditControllerV22

Customer3

CustomerControllerV27

Data3

DataControllerV26

Deposit2

DepositControllerV22

Dispute1

DisputeControllerV21

Estimate2

EstimateControllerV22

ExpenseControllerV22

File1

FinancialBenchmarking1

FinancialBenchmarkingControllerV21

FinancialForecast1

FinancialForecastControllerV21

FinancialFraudRisk1

FinancialFraudRiskControllerV21

FinancialRatio1

FinancialRatioControllerV21

FinancialStatement3

FinancialStatementControllerV26

Inventory3

InventoryControllerV23

Invoice6

InvoiceControllerV210

Journal3

JournalControllerV28

Order1

OrderControllerV21

PaymentMethodControllerV21

PayrollTransaction1

PortfolioMetrics1

PortfolioMetricsControllerV21

ProbabilityOfDefault1

ProbabilityOfDefaultControllerV21

Product1

ProductControllerV21

PurchaseOrder2

PurchaseOrderControllerV22

Refunds4

Reports10

Sandbox2

TaxBenchmarking1

TaxBenchmarkingControllerV21

TaxRate1

TaxRateControllerV23

TrackingCategory2

TrackingCategoryControllerV22

Transaction1

TransactionControllerV21

TrialBalance1

TrialBalanceControllerV21

Vendor3

VendorControllerV28

Visualizations16

Connection

Connections

GET /connections

Changed on Sep 3, 2026

Gets a list of all team's accounting connections.

Request

Base URL
https://api.railz.ai
Auth
HTTP bearer

Query parameters

businessNamestring

Example:Railz

Unique business name identifier.

businessUuidstring

Example:BIZ-26bc4510-8c6f-4688-996d-e87acf3e0b3f

Unique business identifier.

Name of accounting service provider.

institutionNamestring

Name of banking service.

connectionIdstring

Example:CON-e66400c1-4d2f-4683-9bea-275799943695

Unique connection identifier.

connectionUuidstring

Example:CON-e66400c1-4d2f-4683-9bea-275799943695

Unique connection identifier.

status'pending' | 'active' | 'disconnected' | 'expired' | 'invalid'

The status of a connection.

limitnumber

offsetnumber

serviceAccountRef.idstring

Example:12345

serviceAccountRef.entityRef.idstring

Example:100

Response

Example response

{
  "meta": {
    "count": 1
  },
  "data": [
    {
      "connectionUuid": "CON-e66400c1-4d2f-4683-9bea-275799943695",
      "firstRecordDate": "2020-12-25T01:02:03Z",
      "serviceName": "xero",
      "description": "TD Bank",
      "status": "active",
      "createdAt": "2020-12-25T01:02:03Z",
      "updatedAt": "2020-12-25T01:02:03Z",
      "disconnectReason": "disconnectedByCustomer",
      "institution": {
        "name": "Citizens bank",
        "logo": "https://serverlogo.url"
      },
      "isMockData": true,
      "serviceAccountRef": {
        "id": "12345",
        "entityRef": {
          "id": "100"
        }
      },
      "businessUuid": "BIZ-26bc4510-8c6f-4688-996d-e87acf3e0b3f",
      "businessName": "Railz",
      "connectionId": "CON-e66400c1-4d2f-4683-9bea-275799943695"
    }
  ]
}

Changes

Sep 3, 20261383b9a47ac9 Revision changes
- info
  api tag Connection added
Aug 10, 20265cdfae3fa1fa Revision changes
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- breaking
  the response property // became optional for the status
- warning
  added the new dynamics365Finance enum value to the // response property for the response status
- warning
  added the new dynamics365Finance enum value to the // response property for the response status
- warning
  added the new dynamicsBusinessCentral enum value to the // response property for the response status
- warning
  added the new dynamicsBusinessCentral enum value to the // response property for the response status
- warning
  added the new freshbooks enum value to the // response property for the response status
- warning
  added the new freshbooks enum value to the // response property for the response status
- warning
  added the new myob enum value to the // response property for the response status
- warning
  added the new myob enum value to the // response property for the response status
- warning
  added the new oracleNetsuite enum value to the // response property for the response status
- warning
  added the new oracleNetsuite enum value to the // response property for the response status
- warning
  added the new quickbooks enum value to the // response property for the response status
- warning
  added the new quickbooks enum value to the // response property for the response status
- warning
  added the new quickbooksDesktop enum value to the // response property for the response status
- warning
  added the new quickbooksDesktop enum value to the // response property for the response status
- warning
  added the new sageBusinessCloud enum value to the // response property for the response status
- warning
  added the new sageBusinessCloud enum value to the // response property for the response status
- warning
  added the new sageIntacct enum value to the // response property for the response status
- warning
  added the new sageIntacct enum value to the // response property for the response status
- warning
  added the new wave enum value to the // response property for the response status
- warning
  added the new wave enum value to the // response property for the response status
- warning
  added the new xero enum value to the // response property for the response status
- warning
  added the new xero enum value to the // response property for the response status
- warning
  added the new zohoBooks enum value to the // response property for the response status
- warning
  added the new zohoBooks enum value to the // response property for the response status
- info
  added the new optional query request parameter businessUuid
- info
  added the new optional query request parameter connectionUuid
- info
  added the new optional query request parameter limit
- info
  added the new optional query request parameter offset
- info
  added the new optional query request parameter serviceAccountRef.entityRef.id
- info
  added the new optional query request parameter serviceAccountRef.id
- info
  added the new enum value byod to the query request parameter serviceName
- info
  added the new enum value dynamics365Finance to the query request parameter serviceName
- info
  added the new enum value zohoBooks to the query request parameter serviceName
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  response property data/items/firstRecordDate deprecated
- info
  response property data/items/firstRecordDate deprecated
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  the response required property // became not read-only for the status
- info
  the response required property // became not read-only for the status
- info
  the response required property // became not read-only for the status
- info
  the response required property // became not read-only for the status

Operation history