---
title: "Browse Jimmy John's store-URL index"
method: GET
path: "/jimmy-johns/sitemap"
tags: ["JimmyJohns"]
---

# Browse Jimmy John's store-URL index

`GET /jimmy-johns/sitemap`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/jimmy-johns/sitemap`
- Auth: API key in header `x-api-key`

Returns one page of Jimmy John's sitemap-declared store index -- 9,700+ URLs at time of writing. Jimmy John's publishes three page variants per store (sandwiches, delivery, catering) and all three appear in the sitemap, so each entry carries a kind and the store number they share; filter with the kind parameter to enumerate one variant per restaurant. `sandwiches` is the canonical variant. A page past the end returns an empty list rather than an error, so a caller can walk to exhaustion.

## Query parameters

- `shard` integer
- `page` integer
- `page_size` integer
- `kind` 'sandwiches' | 'delivery' | 'catering'

## Headers

- `x-api-key` string, required

## Response `200`

OK

- JimmyjohnsSitemapResponseDoc
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` JimmyjohnsSitemapResponse
    - `count` integer
    - `entries` JimmyjohnsSitemapEntry[]
      - `kind` string: Kind distinguishes the three page variants Jimmy John's publishes per store: sandwiches, delivery and catering. All three describe the same restaurant; `sandwiches` is the canonical one.
      - `path` string
      - `store_number` string: StoreNumber is the trailing id shared by all three variants.
      - `url` string
    - `fetched_at` string
    - `page` integer
    - `shard` integer
    - `shard_count` integer
    - `source_url` string
    - `total_in_shard` integer
    - `total_pages` integer
  - `msg` unknown

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)