Skip to navigation

List product sketches

List product sketchs visible to the API credential, ordered by position, createdAt, and id. Omitting productId lists images across accessible parents. Returns an array.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

productIdstringOptionalformat: "uuid"
Filter by the owning product.
pageintegerOptional>=1Defaults to 1
Page number.
perPageintegerOptional1-200Defaults to 200

Number of results per page; capped at 200.

Response

Image list, including an empty array when there are no matches.
idstringOptionalformat: "uuid"
productIdstringOptionalformat: "uuid"
ID of the product that owns the image.
photoUrlstring or nullOptionalformat: "uri"
positionintegerOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
descriptionstring or nullOptional
sketchGroupIdstring or nullOptionalformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error