API ReferenceDeveloper GuidesRecipesDocumentationCommunityAcademyPlatform
API Reference

Get a requirement by external key

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

Returns an ALM-synchronized requirement by its external issue key. A requirement without a synchronized external issue cannot be found this way. Requires the Requirement:Read permission.

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

External issue key from the requirement sourceId, for example XQE-5; URL-encode it as a path segment.

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 21 days ago

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

Updated 21 days ago

Did this page help you?