catalog

Search published components

Paginated search over published components that have a slug (the public /components pages). A PocketBase failure also answers 200 with empty items.

get/api/components/search

Request

  • Base URL: https://voltplan.app
  • URL: https://voltplan.app/api/components/search
  • Auth: none declared

Query parameters

searchstring

Case-insensitive contains match on name, summary, description and brand name.

typestring

Component type filter, one of battery, charger, inverter, transformer, power, load, bridge, tool; any other value is ignored (no type filter).

sortstring

name (A–Z), -rating (average rating, then review count, descending) or -updated (newest published first); unknown values fall back to -rating.

pageinteger

1-based page number; non-numeric values or values below 1 fall back to 1.

perPageinteger

Page size; non-numeric values or values below 1 fall back to 24, values above 100 are clamped to 100.

Response

One page of matching published components.

pageinteger required

Returned page number.

perPageinteger required

Applied page size.

totalItemsinteger required

Matches across all pages.

totalPagesinteger required

Number of pages.

Changes

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