Skip to navigation

List colorway photos

List colorway photos visible to the API credential, ordered by position, createdAt, and id. Omitting variantId 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

variantIdlongOptional
Filter by the owning colorway.
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"
variantIdlongOptional
Numeric colorway id, not its separate uuid field.
fileUrlstring or nullOptionalformat: "uri"
positionintegerOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
contentTypestring or nullOptional

Media type of the stored file; refreshed when the file is replaced.

seasonIdslist of stringsOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error