Skip to main content
openbridge.articles.list()
openbridge.articles.list().blog('news').limit(10)
Fetches a list of articles. Supports chaining methods to configure the query.

​
Chainable Methods

MethodDescription
.limit(count)Limit number of results (default: 250)
.after(cursor)Fetch results after cursor (pagination)
.before(cursor)Fetch results before cursor (pagination)
.search(query)Filter by search query
.blog(handle)Filter by blog handle
.reverse()Reverse the order
.select(fields)Limit returned fields

​
Returns

ArticlesResult 
{
  items: ShopifyArticle[]
  pageInfo: ShopifyPageInfo
}

​
Examples

​
Basic usage

const { items, pageInfo } = await openbridge.articles.list()

​
From specific blog

const { items } = await openbridge.articles
    .list()
    .blog('news')
    .limit(10)

​
With chained methods

const { items, pageInfo } = await openbridge.articles
    .list()
    .blog('news')
    .limit(10)
    .select(['title', 'handle', 'image', 'excerpt'])

​
Pagination

const page1 = await openbridge.articles.list().limit(10)

if (page1.pageInfo.hasNextPage) {
    const page2 = await openbridge.articles
        .list()
        .limit(10)
        .after(page1.pageInfo.endCursor)
}