---
title: "Get Vendors Meta"
method: GET
path: "/vendors/meta"
---

# Get Vendors Meta

`GET /vendors/meta`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/vendors/meta`
- Auth: API key in header `x-api-key`

Operates on Vendors. In the Zuper client app this module is labeled "Vendor" for most companies, and "Supplier" for companies in the roofing industry — the API and data shape are identical either way. Vendors and Subcontractors share the exact same underlying schema and endpoints; they're distinguished only by the `vendor_type` field (`VENDOR` here) and the `/vendors` vs `/subcontractors` route prefix. Returns the column/field configuration used to render this module's list view — display labels, sort/lock/edit capability, and redirect targets per field, including custom fields (scoped separately per module: `VENDOR` vs `SUBCONTRACTOR`).

## Response `200`

200

- object
  - `type` 'SUCCESS'
  - `data` object[]
    - `display_name` string
    - `display_key` string
    - `data_key` string
    - `field_type` string
    - `data_type` string
    - `display_type` string
    - `is_sortable` boolean
    - `is_locked` boolean
    - `allow_editing` boolean
    - `combine_with` string
    - `checked` boolean
    - `redirect` object
      - `is_enabled` boolean
      - `module` string
      - `data_key` string

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/vendors/meta/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)
