List every active vendor
Returns every active vendor in one response, for filling a picker. There is no paging: the whole set comes back, and the pagination fields are filled in to describe that single page. Deactivated vendors are always excluded, whatever you pass. Requires the vendors:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
namestringOnly vendors whose name matches.
categoryIdstringOnly vendors in this vendor category.
phoneNumberstringOnly vendors with this phone number.
emailstringOnly vendors with this email address.
isCompanyVendorbooleantrue returns only the record that stands for the management company itself; false excludes it.
activebooleantrue returns only vendors that are still active; false returns only deactivated ones.
searchstringFree-text search across the vendor.
portalStatusenum<string>Only vendors at this stage of portal sign-up.
Response
200 · Every active vendor that matches, in the same envelope the paged list uses. `page` is always 1, `totalPages` is always 1, and `pageSize` equals the number of vendors returned.
itemsobject[]requiredEvery matching active vendor.
totalCountintegerrequiredHow many vendors match in total.
totalPagesintegerrequiredHow many pages there are at this page size.
pageintegerrequiredThe page that was returned. Counting starts at 1.
pageSizeintegerrequiredHow many vendors were asked for per page.
401 · The request carried no valid access token.
403 · The token is not a property manager token, or it lacks the `vendors:read` permission.
This endpoint forces the active filter on before it runs, so sending active=false still returns only active vendors. Use List vendors when you need the deactivated ones.