admin-suppliers

List Suppliers

List suppliers (paginated).

Requires vendors:manage permission.

The active query param is tri-state:

  • ?active=true (default) — active rows only
  • ?active=false — inactive rows only
  • omit the param (or send ?active= with explicit null) — all rows
get/api/v1/admin/suppliers/

Query parameters

qstring nullable

Search name / email / company (case-insensitive ilike)

Search name / email / company (case-insensitive ilike)

activeboolean nullable

Three-state filter: true → active only, false → inactive only, omit param → all rows.

Three-state filter: true → active only, false → inactive only, omit param → all rows.

sort'name' | 'last_contacted_at' | 'created_at'

Sort column

Sort column

order'asc' | 'desc'

Sort direction

Sort direction

offsetinteger
limitinteger

Response

Successful Response

totalinteger required
offsetinteger required
limitinteger required
has_moreboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.