Skip to content

Get associated listings

GET
/collections/{handle}/listings
curl --request GET \
--url 'https://acme.mykreezalid.com/api/v1/collections/example/listings?by=handle' \
--header 'Authorization: Basic <credentials>'

Get all listings associated with a specific collection or sub-collection

handle
required
string

The handle (code) of the collection or sub-collection, or its id with by=id

by
string
default: handle
Allowed values: handle id

How the path names the collection: handle (the default, which also finds an integrator’s source handle) or id. A handle may be made of digits only, so an id is never guessed.

The listings attached to the collection, each with its own fields as stored. This list does not use the listing format of the Listings endpoints.

Media typeapplication/json
Array<object>
object

Example generated

[
{}
]

by is not handle or id, or with by=id the reference is not a whole number

Media typeapplication/json

Why a collection or collection model request was refused.

object
success
boolean
message
string
errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
"success": false,
"message": "Collection handle is required"
}

Collection not found

Media typeapplication/json

Why a collection or collection model request was refused.

object
success
boolean
message
string
errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
"success": false,
"message": "Collection handle is required"
}