/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Components API groups

API groups

ApiGroups shows the endpoint groups of your API reference as cards.

1 min read

<ApiGroups> draws your API reference's endpoint groups as cards, each with its first endpoints — a way into the reference from a home page.

Note

Doc engine v2 only (presets). A v1 site doesn't draw <ApiGroups>: used empty it shows nothing, and any content inside it shows as plain text.

Used empty

mdx
<ApiGroups />

With no children, it draws one card per endpoint group of your API reference, listing its first endpoints.

Used empty, it fills itself from your site. Give it content of its own and it shows only that. With no content and nothing on the site to fill it, it draws nothing and the build log says so:

text
<ApiGroups>: the site has no API reference, so it shows nothing. Give it content or remove it.

With your own content

mdx
<ApiGroups title="Browse the API">
<Card title="Transfers" href="/api-reference/transfers">
Move money between accounts.
- [Create a transfer](/api-reference/transfers/create)
- [List transfers](/api-reference/transfers/list)
</Card>
</ApiGroups>

Each <Card title href> is a group: its text is the description and its link list the endpoints.

Props

PropTypeDefaultDescription
titlestring"Browse by product"Heading of the block, where the preset draws one
limitnumber9Most groups shown

In each preset

It's drawn in your preset's home style — or in the layout named by appearance.layout.home while that setting still works. Atlas draws its product cards. The other presets draw their section cards, with the endpoint count. On a page with the normal frame it sits in the content column; on a layout: wide page it runs across the page.

Example

This site's own, from <ApiGroups limit={3} />:

•
Hero and Search — the hero and the home search box
Was this page helpful? Yes No
Previous
Product
Resources
Company
© 2026 SyntextBuilt with Syntext