Developers
Start building
APIs/App API/Products/List products

List products

GET/apps-api/v1/products

Responses are private and never cached.

Required permission

products.read

Query parameters

limitintegerOptional

1 to 100; default 25

cursorstringOptional

max 1024 characters

Headers

Poltura-InstallationstringRequired

Response

productsobject[]Required

max 100 items

idstringRequired
titlestringRequired
handlestringRequired
descriptionstring | nullRequired

max 20000 characters

imageobject | nullRequired
urlstringRequired
altstring | nullRequired
updatedAtstring (date-time)Required
nextCursorstring | nullRequired

max 1024 characters

Errors

StatusCode
400invalid_input, unsupported_api_version
401unauthorized
403forbidden, insufficient_scope
404not_found
409conflict, quota_exceeded
412stale_version
413payload_too_large
429rate_limited
503unavailable