List Redirects | BigCommerce Developer Center

Returns a collection of the store's 301 redirects across all sites.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Content	modify	`store_v2_content`
Content	read-only	`store_v2_content_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Content | modify | `store_v2_content` | | Content | read-only | `store_v2_content_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

site_idintegerOptional

Filters items by site ID.

id:inlist of integersOptional

Filters items by redirect ID. Also accepts comma-separated values to filter for multiple redirects.

id:minintegerOptional

Filters items by minimum redirect ID.

id:maxintegerOptional

Filters items by maximum redirect ID.

limitintegerOptional

Controls the number of items to return per page.

pageintegerOptional

Specifies the page number in a limited (paginated) list of items. Used to paginate large collections.

sortenumOptional

Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to return results in redirect create date order.

Allowed values:

directionenumOptional

Sort direction. Acceptable values are asc, desc.

Allowed values:

includelist of enumsOptional

Indicates whether to include redirect sub-resources. Only to_url is supported.

Allowed values:

keywordstringOptional

Filters redirects by the specified keyword. Will only search from the beginning of a URL path. For example, blue will match /blue and /blue-shirt , not /royal-blue-shirt.

Response

datalist of objects

metaobject

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/storefront/redirects"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"id": 1,
5	"site_id": 1,
6	"from_path": "/old-url",
7	"to": {
8	"type": "product",
9	"entity_id": 1,
10	"url": "/new-url/"
11	},
12	"to_url": "https://store-domain.com/new-url"
13	}
14	],
15	"meta": {
16	"pagination": {
17	"total": 246,
18	"count": 5,
19	"per_page": 5,
20	"current_page": 1,
21	"total_pages": 50,
22	"links": {
23	"next": "?limit=5&page=2",
24	"current": "?limit=5&page=1"
25	}
26	}
27	}
28	}