> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# The vendor list (UI spec §20).

> Categories, sites, live contracts, best committed response, rating, open and warranty work, and
whether compliance allows them to be assigned at all.



## OpenAPI

````yaml /api-reference/openapi.json get /vendor_directory
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes (ADR-014). Reads are security_invoker
    views; writes are SECURITY DEFINER functions. Rebuilt wholesale on every
    deploy — it holds no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Routing
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Self verification
  - name: Setup
  - name: Tools on a job, and who has them out
  - name: Vendors and contracts
  - name: Work order execution
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /vendor_directory:
    get:
      tags:
        - Vendors and contracts
      summary: The vendor list (UI spec §20).
      description: >-
        Categories, sites, live contracts, best committed response, rating, open
        and warranty work, and

        whether compliance allows them to be assigned at all.
      parameters:
        - $ref: '#/components/parameters/rowFilter.vendor_directory.vendor_id'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.vendor_number'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.name'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.legal_name'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.vendor_type'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.is_oem'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.status'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.status_label'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.status_category'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.email'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.phone'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.website'
        - $ref: >-
            #/components/parameters/rowFilter.vendor_directory.payment_terms_days
        - $ref: '#/components/parameters/rowFilter.vendor_directory.onboarded_on'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.approved_on'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.performance_score'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.is_active'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.categories'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.site_count'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.active_contracts'
        - $ref: >-
            #/components/parameters/rowFilter.vendor_directory.best_response_minutes
        - $ref: '#/components/parameters/rowFilter.vendor_directory.average_rating'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.rating_count'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.open_work_orders'
        - $ref: >-
            #/components/parameters/rowFilter.vendor_directory.warranty_work_orders
        - $ref: '#/components/parameters/rowFilter.vendor_directory.open_claims'
        - $ref: '#/components/parameters/rowFilter.vendor_directory.is_assignable'
        - $ref: >-
            #/components/parameters/rowFilter.vendor_directory.compliance_expiring
        - $ref: >-
            #/components/parameters/rowFilter.vendor_directory.warranty_authorisations
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/vendor_directory'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/vendor_directory'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/vendor_directory'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/vendor_directory'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.vendor_directory.vendor_id:
      in: query
      name: vendor_id
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.vendor_number:
      in: query
      name: vendor_number
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.legal_name:
      in: query
      name: legal_name
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.vendor_type:
      in: query
      name: vendor_type
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.is_oem:
      in: query
      name: is_oem
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.status:
      in: query
      name: status
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.status_label:
      in: query
      name: status_label
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.status_category:
      in: query
      name: status_category
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.email:
      in: query
      name: email
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.phone:
      in: query
      name: phone
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.website:
      in: query
      name: website
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.payment_terms_days:
      in: query
      name: payment_terms_days
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.onboarded_on:
      in: query
      name: onboarded_on
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.approved_on:
      in: query
      name: approved_on
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.performance_score:
      in: query
      name: performance_score
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.categories:
      in: query
      name: categories
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.site_count:
      in: query
      name: site_count
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.active_contracts:
      in: query
      name: active_contracts
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.best_response_minutes:
      in: query
      name: best_response_minutes
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.average_rating:
      in: query
      name: average_rating
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.rating_count:
      in: query
      name: rating_count
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.open_work_orders:
      in: query
      name: open_work_orders
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.warranty_work_orders:
      in: query
      name: warranty_work_orders
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.open_claims:
      in: query
      name: open_claims
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.is_assignable:
      in: query
      name: is_assignable
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.compliance_expiring:
      in: query
      name: compliance_expiring
      required: false
      schema:
        type: string
    rowFilter.vendor_directory.warranty_authorisations:
      in: query
      name: warranty_authorisations
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    vendor_directory:
      description: >-
        The vendor list (UI spec §20).


        Categories, sites, live contracts, best committed response, rating, open
        and warranty work, and

        whether compliance allows them to be assigned at all.
      properties:
        active_contracts:
          format: bigint
          type: integer
        approved_on:
          format: date
          type: string
        average_rating:
          format: numeric
          type: number
        best_response_minutes:
          format: integer
          type: integer
        categories:
          format: jsonb
        compliance_expiring:
          format: bigint
          type: integer
        email:
          format: public.citext
          type: string
        is_active:
          format: boolean
          type: boolean
        is_assignable:
          format: boolean
          type: boolean
        is_oem:
          format: boolean
          type: boolean
        legal_name:
          format: character varying
          maxLength: 250
          type: string
        name:
          format: character varying
          maxLength: 200
          type: string
        onboarded_on:
          format: date
          type: string
        open_claims:
          format: bigint
          type: integer
        open_work_orders:
          format: bigint
          type: integer
        payment_terms_days:
          format: integer
          type: integer
        performance_score:
          format: numeric
          type: number
        phone:
          format: character varying
          maxLength: 40
          type: string
        rating_count:
          format: bigint
          type: integer
        site_count:
          format: bigint
          type: integer
        status:
          format: character varying
          maxLength: 60
          type: string
        status_category:
          format: character varying
          maxLength: 20
          type: string
        status_label:
          format: character varying
          maxLength: 150
          type: string
        vendor_id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        vendor_number:
          format: character varying
          maxLength: 60
          type: string
        vendor_type:
          format: character varying
          maxLength: 40
          type: string
        warranty_authorisations:
          format: bigint
          type: integer
        warranty_work_orders:
          format: bigint
          type: integer
        website:
          format: character varying
          maxLength: 250
          type: string
      type: object

````

## Related topics

- [Vendors](/commercial/vendors.md)
- [The asset register](/assets/register.md)
- [Administered lists](/config/administered-lists.md)
- [Vendor and contract settings](/config/commercial.md)
- [The work order list](/work/work-orders.md)