Skip to main content
GET
The vendor list (UI spec §20).

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

vendor_id
string
vendor_number
string
name
string
vendor_type
string
is_oem
string
status
string
status_label
string
status_category
string
email
string
phone
string
website
string
payment_terms_days
string
onboarded_on
string
approved_on
string
performance_score
string
is_active
string
categories
string
site_count
string
active_contracts
string
best_response_minutes
string
average_rating
string
rating_count
string
open_work_orders
string
warranty_work_orders
string
open_claims
string
is_assignable
string
compliance_expiring
string
warranty_authorisations
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

active_contracts
integer<bigint>
approved_on
string<date>
average_rating
number<numeric>
best_response_minutes
integer<integer>
categories
string<jsonb>
compliance_expiring
integer<bigint>
email
string<public.citext>
is_active
boolean<boolean>
is_assignable
boolean<boolean>
is_oem
boolean<boolean>
Maximum string length: 250
name
string<character varying>
Maximum string length: 200
onboarded_on
string<date>
open_claims
integer<bigint>
open_work_orders
integer<bigint>
payment_terms_days
integer<integer>
performance_score
number<numeric>
phone
string<character varying>
Maximum string length: 40
rating_count
integer<bigint>
site_count
integer<bigint>
status
string<character varying>
Maximum string length: 60
status_category
string<character varying>
Maximum string length: 20
status_label
string<character varying>
Maximum string length: 150
vendor_id
string<uuid>

Note: This is a Primary Key.

vendor_number
string<character varying>
Maximum string length: 60
vendor_type
string<character varying>
Maximum string length: 40
warranty_authorisations
integer<bigint>
warranty_work_orders
integer<bigint>
website
string<character varying>
Maximum string length: 250