---
title: "Fetch the OpenAPI document"
method: GET
path: "/api/v1/openapi.json"
tags: ["Discovery"]
---

# Fetch the OpenAPI document

`GET /api/v1/openapi.json`

## Request

- Base URL: `https://spoonjoy.app`
- URL: `https://spoonjoy.app/api/v1/openapi.json`
- Auth: none required

## Headers

- `X-Request-Id` string

## Response `200`

Success

- OpenApiDocument
  - `openapi` '3.1.0', required
  - `info` OpenApiInfo, required
    - `title` string, required
    - `version` string, required
    - `description` string, required
  - `servers` OpenApiServer[], required
    - `url` string, required
  - `paths` object, required
  - `components` object, required
  - `x-oauth-scope-map` object
  - `x-auth-flows` object[]
  - `x-client-scenarios` object[]
  - `x-current-capabilities` object

## Other responses

- `400`: Errors: validation_error
- `401`: Errors: invalid_token
- `405`: Errors: method_not_allowed
- `429`: Errors: rate_limited
- `500`: Errors: internal_error
- `503`: Errors: temporarily_unavailable

---

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