---
title: "List Requirements"
method: GET
path: "/requirements"
tags: ["requirements"]
---

# List Requirements

`GET /requirements`

## Request

- Base URL: `https://api.specproof.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.specproof.ai/requirements`
- Auth: none declared

## Query parameters

- `document_id` integer, nullable
- `spec` string, nullable: LIKE match on corpus spec_number/filename
- `obligation` string, nullable
- `keyword` string, nullable
- `search` string, nullable: substring match on requirement text
- `coverage` string, nullable: filter: 'covered' | 'gap'
- `page` integer
- `per_page` integer

## Headers

- `X-Org-Id` string, nullable
- `authorization` string

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

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