---
title: "Search Vendors"
method: GET
path: "/v1/web/vendor"
tags: ["Vendor"]
---

# Search Vendors

`GET /v1/web/vendor`

Payment method details are returned as reference only. Use `GET /vendor/{id}` to retrieve the full details.

## Query parameters

- `ids` string
- `externalIds` string
- `statuses` string
- `ownerUserIds` string
- `ownerUserGroupIds` string
- `countries` string
- `spendCategoryIds` string
- `merchantIds` string
- `nameLike` string
- `legalNameLike` string
- `createdAt` string
- `updatedAt` string
- `page` integer
- `pageSize` integer
- `orderBy` string

## Response `200`

Default Response

- object
  - `items` object[], required
    - `id` string, required
    - `externalId` string
    - `status` union, required
      - 'active'
      - 'disabled'
      - 'deleted'
    - `name` string, required
    - `owners` object, required
      - `userIds` string[], required
      - `userGroupIds` string[]
    - `currencyCode` string, required
    - `accountingIntegration` object
      - `rutterId` string
      - `platformId` string
      - `latestSync` object, required
        - `status` union, required
          - 'inProgress'
          - 'successful'
          - 'failed'
        - `createdAt` string, date-time, required
        - `completedAt` string, date-time
        - `error` object
          - `type` string
          - `code` string
          - `message` string
    - `country` string, required
    - `logoUrl` string
    - `spendCategoryId` string
    - `merchantIds` string[]
    - `merchantCategory` string
    - `legalName` string
    - `taxId` object
      - `type` union, required
        - 'ssn'
        - 'ein'
      - `id` string, required
    - `address` object
      - `attn` string
      - `line1` string, required
      - `line2` string
      - `city` string, required
      - `zipCode` string, required
      - `state` string, required
      - `country` string, required
    - `contacts` object[], required
      - `id` string, required
      - `type` union
        - 'accountsPayable'
        - 'accountsReceivable'
        - 'it'
        - 'procurement'
        - 'sales'
        - 'support'
        - 'other'
      - `name` object, required
        - `firstName` string, required
        - `middleName` string
        - `lastName` string, required
      - `default` boolean, required
      - `email` string, required
      - `phone` string
      - `notes` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `paymentMethods` object[], required
      - `id` string, required
      - `type` 'ach', required
  - `hasNext` boolean, required
  - `totalCount` number, required

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/versions/ac700d65f443/schema)