> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# knowledgeArticles
> List Commerce Agent knowledge articles, optionally filtered by title/body substring, status, or origin.
**Required scopes:** [`commerce_agent_knowledge_read`](/docs/api-reference/v3/reference/scopes#scope-commerce_agent_knowledge_read)
## Arguments
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
KnowledgeArticleSortKey}>
Which key to sort by (defaults to createdAt, newest-first). Combine with `reverse` to flip direction.
KnowledgeArticleOrigin}>
Only include articles with this origin.
Case-insensitive substring match on title or content. For ranked search, use `searchKnowledgeArticles`.
Reverses the sort direction selected by `orderBy` (or its default).
KnowledgeArticleStatus}>
Only include articles with this status.
## Returns
KnowledgeArticleConnection!} required>
A paginated list of KnowledgeArticle items.
[KnowledgeArticleEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
KnowledgeArticle!} required>
The item at this edge.
The article body as authored.
DateTime!} required>
When the article was created.
DateTime}>
When the article stops being retrievable. Null means no end.
DateTime}>
When the article becomes retrievable, if `status` is ACTIVE. Null means immediately.
The id of this knowledge article.
KnowledgeArticleOrigin!} required>
How this article was created. Immutable after create.
ProductFamilyConnection!} required>
Product families this article cites.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
KnowledgeArticleConnection!} required>
Other knowledge articles this article cites.
**Requires:** [`commerce_agent_knowledge_read`](/docs/api-reference/v3/reference/scopes#scope-commerce_agent_knowledge_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
KnowledgeArticleStatus!} required>
Whether Commerce Agent may retrieve this article. Combine with the effective window.
The merchant-facing title of the article.
DateTime!} required>
When the article body was last edited.
[KnowledgeArticle!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
The article body as authored.
DateTime!} required>
When the article was created.
DateTime}>
When the article stops being retrievable. Null means no end.
DateTime}>
When the article becomes retrievable, if `status` is ACTIVE. Null means immediately.
The id of this knowledge article.
KnowledgeArticleOrigin!} required>
How this article was created. Immutable after create.
ProductFamilyConnection!} required>
Product families this article cites.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductFamilyEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[ProductFamily!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
KnowledgeArticleConnection!} required>
Other knowledge articles this article cites.
**Requires:** [`commerce_agent_knowledge_read`](/docs/api-reference/v3/reference/scopes#scope-commerce_agent_knowledge_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
KnowledgeArticleStatus!} required>
Whether Commerce Agent may retrieve this article. Combine with the effective window.
The merchant-facing title of the article.
DateTime!} required>
When the article body was last edited.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
knowledgeArticles(after: "...", before: "...", first: 10, last: 10, orderBy: CREATED_AT, origin: AI_SUGGESTED, query: "...", reverse: true, status: ACTIVE) {
nodes {
content
createdAt
effectiveEndAt
effectiveStartAt
id
origin
status
title
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.