Skip to main content
openbridge.collections.list().search(query)
Filters collections by a text query.

​
Parameters

ParamTypeRequiredDescription
querystringYesSearch query string

​
Returns

CollectionListBuilder (chainable)

​
Examples

const { items } = await openbridge.collections.list().search('sale')

​
With limit

const { items } = await openbridge.collections.list().search('summer').limit(5)

​
With field selection

const { items } = await openbridge.collections
    .list()
    .search('new')
    .select(['title', 'handle', 'image'])

​
Combined with pagination

const page1 = await openbridge.collections.list().search('featured').limit(10)

if (page1.pageInfo.hasNextPage) {
    const page2 = await openbridge.collections
        .list()
        .search('featured')
        .limit(10)
        .after(page1.pageInfo.endCursor)
}