Get requirements

GET/requirements

Base URL https://app.testsigma.com/api/v1Region

Retrieve all test requirements linked to the project's application version.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Response attributes

`id`	Unique requirement identifier.
`requirementName`	Name of the requirement.
`requirementDescription`	Detailed description of the requirement.
`requirementTypeId`	ID of the requirement type category.
`applicationVersionId`	ID of the application version this requirement targets.
`plannedManualCount`	Number of planned manual test cases.
`plannedAutomationCount`	Number of planned automated test cases.
`startTime`	Epoch timestamp for planned start.
`endTime`	Epoch timestamp for planned end.

Request

curl -X GET \
  'https://app.testsigma.com/api/v1/requirements' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://app.testsigma.com/api/v1/requirements', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://app.testsigma.com/api/v1/requirements',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "content": [
    {
      "id": 71,
      "requirementName": "User Authentication",
      "requirementDescription": "All login and logout flows",
      "requirementTypeId": 78,
      "applicationVersionId": 47,
      "plannedManualCount": 5,
      "plannedAutomationCount": 10,
      "startTime": 1658114333000,
      "endTime": 1660706333000,
      "createdById": 9
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Was this page helpful?