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.

Endpoint

EndpointMethod
/api/admin/marketing/sitemapsGET

Response envelope

Admin collections return a { data, meta } body envelope:

  • data — the sitemap rows for this page.
  • metacurrentPage, perPage, lastPage, total, from, to.

Each row carries the flat sitemap fields shown in the example. The built XML paths — indexFile and generatedSitemaps — are served only by the detail endpoint; they are not present on list rows. generatedAt stays null until the sitemap has been generated at least once.

Query parameters

ParameterDescription
page, per_pagePagination (per_page default 10, max 50)
file_nameFile name — partial match
sort, orderSort field (id, file_name) + asc / desc (default id desc)

Filters compose with logical AND — more filters narrow the result.

Every /api/admin/* request requires an admin Bearer token.

Released under the MIT License.