List all app redirects

Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query

GET/api/v1/{team_slug}/{app_slug}/redirects
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/redirects

Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/redirects
  • Summary: List all app redirects
  • Description: Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters6 parameters
NameInRequiredTypeDescription
pagequeryNointegerPage number
per-pagequeryNointegerNumber of items per page
typequeryNointegerRedirect type, Can be one of product page collection category product_bundle brand serie campaign
searchqueryNostringSearch on old_slug and new_slug
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200Redirect Listapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Redirect List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Redirects
PropertyTypeRequiredDetails
idstringNo-
item_idstringNo-
localestringNo-
new_slugstringNo-
old_slugstringNo-
typeenum("product", "page", "collection", "category", "product_bundle")No-

Generated example (synthetic):

{
  "data": [
    {
      "id": "string",
      "item_id": "string",
      "locale": "string",
      "new_slug": "string",
      "old_slug": "string",
      "type": "product"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/redirects
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Redirects
  • OpenAPI summary: List all app redirects

List all app redirects

# List all app redirects Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query
GET /api/v1/{team_slug}/{app_slug}/redirects
Purpose

Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query

Required inputs

app_slug path team_slug path

Primary response

200 ยท Redirect List

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/redirects

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/redirects` - Summary: List all app redirects - Description: Retrieves a paginated list of all redirects within the specified application, with optional filtering by type and search query - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/redirects` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | page | query | No | integer | Page number | | per-page | query | No | integer | Number of items per page | | type | query | No | integer | Redirect type, Can be one of product page collection category product_bundle brand serie campaign | | search | query | No | string | Search on old_slug and new_slug | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Redirect List | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Redirect List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Redirects | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `item_id` | string | No | - | | `locale` | string | No | - | | `new_slug` | string | No | - | | `old_slug` | string | No | - | | `type` | enum("product", "page", "collection", "category", "product_bundle") | No | - | **Generated example (synthetic):** ```json { "data": [ { "id": "string", "item_id": "string", "locale": "string", "new_slug": "string", "old_slug": "string", "type": "product" } ], "success": false, "total": 0, "total_pages": 0 } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/redirects` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/redirects` - OpenAPI tag: Redirects - OpenAPI summary: List all app redirects