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.

Endpoint

EndpointMethod
/api/admin/marketing/url-rewritesGET

Response envelope

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

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

Each row carries the full rewrite fields shown in the example.

Query parameters

ParameterDescription
page, per_pagePagination (per_page default 10, max 50)
entity_typeproduct / category / cms_page
request_pathSource path — partial match
redirect_type301 (permanent) / 302 (temporary)
localeLocale code
sort, orderSort field (id, entity_type, locale, redirect_type) + 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.