docs
  1. Admin Api
  2. Resources
  3. Redirects
  4. List Redirects

List redirects

Get redirects based on the given filters.

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms

Query Parameters

ParameterDetails
with
Array of arrays
Example:
?with=parent
array
filters[search]
string
filters[id]
Array of integers
integer
sort
string
Enum:
id
source
target
createdAt
updatedAt
statusCode
priority
isRegex
Default:
createdAt
sortDir
string
Enum:
asc
desc
Default:
desc
limit
  • Minimum: 1
  • Maximum: 5000
integer
Default:
100
cursor
string

Responses

200
A list of redirects
application/json
Success
Array of object
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
GET/shops/{shopKey}/redirects

Request samples

Response samples

200
Redirects:
Content type: application/json
Provide Feedback