---
title: "GET /vendors"
method: GET
path: "/vendors"
tags: ["Vendor", "Vendors"]
---

# GET /vendors

`GET /vendors`

## Request

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

Gets the latest vendors/suppliers for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks', required
- `offset` number
- `limit` number
- `orderBy` string

## Response `200`

- GetVendorResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `count` number, required
  - `meta` ListReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `data` GetVendorData[], required
    - `id` string, required
    - `vendorName` string
    - `contactName` string
    - `emailAddress` string
    - `website` string
    - `phone` string
    - `taxNumber` string
    - `balance` number, float
    - `status` 'unknown' | 'active' | 'archived', required
    - `subsidiaryRefs` SubsidiaryRef[]
      - `id` string
      - `name` string
    - `sourceModifiedDate` string
    - `parentRef` ParentRef
      - `id` string, required
      - `name` string
    - `defaultCurrency` CurrencyRef
      - `id` string, required
      - `name` string
      - `symbol` string
    - `addresses` Address[]
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string
      - `country` string
      - `postalCode` string
      - `type` 'billing' | 'shipping' | 'other', required
    - `contacts` Contact[]
      - `name` string
      - `email` string
      - `phone` string
      - `address` Address
        - `line1` string
        - `line2` string
        - `city` string
        - `region` string
        - `country` string
        - `postalCode` string
        - `type` 'billing' | 'shipping' | 'other', required
      - `status` 'unknown' | 'active' | 'archived', required
      - `modifiedDate` string

## 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 `Vendor` added
- **2026-08-10** `5cdfae3fa1fa`: 7 breaking, 26 warning, 8 info
  - removed the enum value `plaid` from the `query` request parameter `serviceName`
  - removed the enum value `shopify` from the `query` request parameter `serviceName`
  - removed the enum value `square` from the `query` request parameter `serviceName`
  - the response property `data/items/subsidiaryRefs/items/id` became optional for the status `200`
  - …37 more

[Operation history](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/changes/vendors/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)