API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
API Reference

Get a requirement

get
https://{tenant}.katalon.io/v2/tm/requirements/

Reads a requirement by its True Platform ID in the project. Requires Requirement:Read. This ID is not its external issue key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

ID of the requested test asset.

Query Params
includeFields
array of strings

Optional extra fields, such as sprints, assignee, linkedTestCaseCount, releases, or renderedDescription.

includeFields
Headers
string

Optional account UUID for selecting account context explicitly.

int64

Optional organization ID for selecting organization context explicitly.

int64
required

True Platform project ID, not a repository ID.

Responses

default

The request could not be completed. Inspect the response before retrying a mutation.

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 5 hours ago

Did this page help you?