API ReferenceSuppliers

List Suppliers

Returns a paginated list of suppliers for the authenticated business. Optionally filter by name using search.

Requires scope: suppliers:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

searchstringOptional

Filter by business name (partial match).

sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, businessName, businessEmail, contactName, phoneNumber, address, city, state, zipCode, website, note, createdAt, updatedAt. Default order (when no sort is supplied): updatedAt,desc.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error