Skip to content

List URL Rewrites

Lists every URL rewrite in the store — the data behind the admin Marketing → Search & SEO → URL Rewrites datagrid.

TIP

New here? Read the URL Rewrites overview for what a URL rewrite does and how its fields behave.

Operation

OperationTypePurpose
adminMarketingUrlRewritesQueryCursor-paginated list of all URL rewrites

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 full flat field set shown in the example. There are no detail-only relation fields, so list rows and the detail query resolve the same fields.

Filtering

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

ArgumentDescription
entityTypeproduct / category / cms_page
requestPathSource path — partial match
redirectType301 (permanent) / 302 (temporary)
localeLocale code (e.g. en)
sort, orderSort field (id, entity_type, locale, redirect_type) + asc / desc (default id desc)

Released under the MIT License.