Skip to content

List Sitemaps

Lists every sitemap definition in the store — the data behind the admin Marketing → Search & SEO → Sitemaps datagrid.

TIP

New here? Read the Sitemaps overview for what a sitemap does and how its fields behave.

Operation

OperationTypePurpose
adminMarketingSitemapsQueryCursor-paginated list of all sitemaps

Details

  • Requires an admin Bearer token in the Authorization header.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance. totalCount is the grand total.
  • Each node carries the flat sitemap fields shown in the example. The indexFile and generatedSitemaps paths resolve only on the detail query — they are omitted from list rows.

Filtering

Pass any of these arguments alongside first / after (they mirror the admin datagrid filters):

ArgumentDescription
fileNameFile name — partial match
sort, orderSort field (id, file_name) + asc / desc (default id desc)

Released under the MIT License.