RESTAdminManagementRedirectsImport Export

List Redirect Import-Export Jobs

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](/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

idstringOptionalformat: "uuid"

Filters results by redirect import-export job ID.

typeenumOptional

Filters results by the type of the redirect import-export job.

Allowed values:
statusenumOptional

Filters results by the status of the Redirect Import-Export job.

Allowed values:
limitintegerOptionalDefaults to 10
Determines the number of items returned per page. The default is 10 items per page.
pageintegerOptional
Specifies the page number to return when the number of items returned exceeds the page limit. Used to paginate large collections.

Response

datalist of objects
metaobject