API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
API Reference

Search requirements

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

Returns a page of project requirements. Requires Requirement:Read. External-key lookup and coverage links require an ALM-synchronized external issue; they do not provide native requirement creation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search expression. URL-encode the expression when constructing requests.

integer
≥ 0
Defaults to 0

Zero-based page number.

integer
1 to 100
Defaults to 100

Page size. Values above 100 are capped at 100.

string

Sort expression for the search.

boolean
Defaults to false

Request a count without fetching the full page of records.

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?