---
title: "GET /connections"
method: GET
path: "/connections"
tags: ["Connection", "Connections"]
---

# GET /connections

`GET /connections`

## Request

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

Gets a list of all team's accounting connections.

## Query parameters

- `businessName` string
- `businessUuid` string
- `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'shopify' | 'square' | 'plaid' | 'myob' | 'zohoBooks' | 'byod'
- `institutionName` string
- `connectionId` string
- `connectionUuid` string
- `status` 'pending' | 'active' | 'disconnected' | 'expired' | 'invalid'
- `limit` number
- `offset` number
- `serviceAccountRef.id` string
- `serviceAccountRef.entityRef.id` string

## Response `200`

- ConnectionsResponseDto
  - `meta` MetaDataCount, required
    - `count` number, required
  - `data` ConnectionsResponseData[], required
    - `connectionUuid` string, required
    - `firstRecordDate` string, date-time
    - `serviceName` 'quickbooks' | 'xero' | 'freshbooks' | 'quickbooksDesktop' | 'sageIntacct' | 'sageBusinessCloud' | 'oracleNetsuite' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'zohoBooks' | 'myob', required
    - `description` string
    - `status` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `disconnectReason` string
    - `syncTime` number
    - `institution` ConnectionsInstitutionData
      - `name` string, required
      - `logo` string, required
    - `isMockData` boolean
    - `serviceAccountRef` ServiceAccountRefType
      - `id` string
      - `entityRef` object, nullable
        - `id` string
    - `businessUuid` string, required
    - `businessName` string, required
    - `connectionId` string, required

## Other responses

- `202`: Data in pending state
- `204`: No data available
- `400`: Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401`: Unauthorized - Not logged in or log in expired
- `403`: Forbidden - Not enough permission
- `500`: Server Error

## Changes

- **2026-09-03** `1383b9a47ac9`: 1 info
  - api tag `Connection` added
- **2026-08-10** `5cdfae3fa1fa`: 4 breaking, 24 warning, 25 info
  - the response property `data/items/description` became optional for the status `200`
  - the response property `data/items/description` became optional for the status `202`
  - the response property `data/items/firstRecordDate` became optional for the status `200`
  - the response property `data/items/firstRecordDate` became optional for the status `202`
  - …49 more

[Operation history](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/changes/connections/get.md)

---

[API](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api.md) - [All operations](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/revisions/1383b9a47ac9?raw)
