---
title: "This API as an OpenAPI 3.1 document"
method: GET
path: "/api/v1/openapi.json"
---

# This API as an OpenAPI 3.1 document

`GET /api/v1/openapi.json`

## Request

- Base URL: `https://ipmusk.com`
- URL: `https://ipmusk.com/api/v1/openapi.json`
- Auth: none declared

The machine-readable description of every /api/v1 endpoint, for importing into tools. Not wrapped in the data envelope.

## Response `200`

This API as an OpenAPI 3.1 document

- object
  - `openapi` '3.1.0', required
  - `info` object, required
    - `title` string, required
    - `version` string, required
    - `description` string, required
  - `servers` object[], required
    - `url` string, required
  - `paths` object, required
  - `components` object, required

## Other responses

- `default`: Any failure: 400 validation_error, 401 authentication_required, 403 forbidden / capability_unavailable, 404 not_found, 409 invalid_state_transition / idempotency_conflict, 422 product_unavailable, 429 rate_limited, 500 internal_error.

---

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