---
title: "The whole dataset in one call"
method: GET
path: "/v1/export"
---

# The whole dataset in one call

`GET /v1/export`

## Request

- Base URL: `https://shipshapedata.com/api`
- URL: `https://shipshapedata.com/api/v1/export`
- Auth: OAuth 2 (client credentials, token URL `https://shipshapedata.com/oauth/token`, scopes: `export`)

Complete export: services, industries, case studies, all 169 guides, and the assessment, as one JSON document. The only authenticated endpoint: takes a free OAuth 2.0 bearer token (client credentials; self-serve registration at /oauth/register, tokens at /oauth/token, walkthrough at https://shipshapedata.com/auth.md). Without a token it returns 401 with a WWW-Authenticate header pointing at the RFC 9728 resource metadata.

## Response `200`

The complete dataset

- BulkExport
  - `exportedAt` string, date-time, required
  - `client` string: The client_id the token was issued to
  - `services` Page[], required
    - `name` string, required
    - `slug` string, required
    - `url` string, uri, required: Canonical HTML page; a markdown twin is at this URL plus index.md
    - `description` string, required
  - `industries` Page[], required
    - `name` string, required
    - `slug` string, required
    - `url` string, uri, required: Canonical HTML page; a markdown twin is at this URL plus index.md
    - `description` string, required
  - `caseStudies` Page[], required
    - `name` string, required
    - `slug` string, required
    - `url` string, uri, required: Canonical HTML page; a markdown twin is at this URL plus index.md
    - `description` string, required
  - `resources` Resource[], required
    - `title` string, required
    - `slug` string, required
    - `url` string, uri, required
    - `category` string, required
    - `description` string, required
    - `answers` string[]: The questions this guide answers
    - `relevance` integer: Present on keyword searches: how many query terms matched
  - `assessment` Assessment, required
    - `title` string, required
    - `instructions` string
    - `sections` object[], required
      - `title` string, required
      - `key` 'strategy' | 'people' | 'data' | 'change', required
      - `desc` string
      - `questions` object[], required
        - `q` string, required
        - `scored` boolean: false = unscored sizing context
        - `ctx` string
        - `opts` string[], required: Five options; the answer is the option index 0-4
    - `bands` object[], required
      - `min` number, required
      - `name` string, required
  - `contact` Contact
    - `company` string, required
    - `location` string
    - `email` string, email, required
    - `website` string, uri, required
    - `how` string
    - `note` string

## Other responses

- `401`: Missing or invalid bearer token; WWW-Authenticate carries the resource metadata URL

---

[API](https://skmtc.dev/shipshapedata/apis/shipshape-data-api.md) · [All operations](https://skmtc.dev/shipshapedata/apis/shipshape-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shipshapedata/apis/shipshape-data-api/revisions/2d494a3e5dbc?raw)
