Supercheck LogoSupercheck
Requirements API

List requirements

List requirements in the current project, newest first. Requires requirement:view. Each item includes the linked test IDs (testIds) and tag names (tagNames) so clients do not need a per-row detail request. The response also repeats the items under requirements for backward compatibility.

GET
/api/requirements

Authorization

bearerAuth
headerAuthorizationBearer <token>

Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.

Query Parameters

page?integer

Page number. Out-of-range values are clamped.

Range1 <= value <= 100000
Default1
pageSize?integer

Items per page. Values outside 1..500 are clamped; the default is 500.

Range1 <= value <= 500
Default500
search?string

Match against title or description (substring).

priority?string

Filter by priority.

Value in"low""medium""high"
status?string

Filter by coverage status. Requirements with no computed coverage count as missing.

Value in"covered""failing""missing"

Response Body

Requirements page

application/json
  1. response
data?array<>
requirements?array<>

Alias of data.

total?integer
page?integer
pageSize?integer
Example Request
curl -X GET 'https://demo.supercheck.dev/api/requirements'
Example Response
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "description": "string",      "priority": "low",      "tags": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "color": "string"        }      ],      "tagNames": [        "string"      ],      "testIds": [        "59250cde-f034-4b67-8215-4abdcfc601c8"      ],      "sourceDocumentId": "b3193c5c-5cd3-497e-a388-85c453411cad",      "sourceDocumentName": "string",      "sourceSection": "string",      "externalId": "string",      "externalUrl": "string",      "externalProvider": "string",      "createdBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "coverageStatus": "covered",      "linkedTestCount": 0,      "passedTestCount": 0,      "failedTestCount": 0    }  ],  "requirements": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "description": "string",      "priority": "low",      "tags": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "color": "string"        }      ],      "tagNames": [        "string"      ],      "testIds": [        "59250cde-f034-4b67-8215-4abdcfc601c8"      ],      "sourceDocumentId": "b3193c5c-5cd3-497e-a388-85c453411cad",      "sourceDocumentName": "string",      "sourceSection": "string",      "externalId": "string",      "externalUrl": "string",      "externalProvider": "string",      "createdBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "coverageStatus": "covered",      "linkedTestCount": 0,      "passedTestCount": 0,      "failedTestCount": 0    }  ],  "total": 0,  "page": 0,  "pageSize": 0}