Products
/products
Lists the project’s catalogue, or searches it with query.
Paging is by page number, not cursor: the catalogue is a search index whose order changes as it re-indexes, and a cursor would silently skip rows across a re-index. Use total to size the walk.
Requires the products:read scope.
get/projects/{project_id}/products
Request
- Base URL: https://api.productbyte.com/v1
- URL: https://api.productbyte.com/v1/projects/{project_id}/products
- Auth: HTTP bearer
Path parameters
project_idstring required
The project whose catalogue to read.
Query parameters
querystring
Match against product name, URL, and other indexed text.
pageinteger nullable
Page to return, counting from 0.
limitinteger
Page size, 1–100.
include_rawboolean nullable
Include each product’s raw fields. Off by default: a full page of catalogue documents is far larger than the named fields, and most callers never read them.
Response
A page of products.
Changes
No recorded changes to this operation across all 2 revisions of this API.