List Redirect Import-Export Jobs

GET

https://api.bigcommerce.com/stores/:store_hash/v3/storefront/redirects/imex/jobs

GET

/stores/:store_hash/v3/storefront/redirects/imex/jobs

curl https://api.bigcommerce.com/stores/store_hash/v3/storefront/redirects/imex/jobs \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Retrieved

{
  "data": [
    {
      "id": "string",
      "type": "import",
      "status": "new",
      "completed_items": 1,
      "failed_items": 1,
      "total_items": 1,
      "errors": [
        {
          "row": 1,
          "message": "string"
        }
      ],
      "created_at": "2022-01-04T04:15:50.000Z",
      "completed_at": "2022-01-04T04:15:50.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "total": 246,
      "count": 5,
      "per_page": 5,
      "current_page": 1,
      "total_pages": 50,
      "links": {
        "next": "?limit=5&page=2",
        "current": "?limit=5&page=1"
      }
    }
  }
}

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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

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 objectsOptional

metaobjectOptional