Get a test suite

View as Markdown
Returns the suite with its test cases nested.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
test_suite_idstringRequired

Headers

X-API-KeystringRequired
Your workspace API key.

Response

Successful Response
test_suite_idstring
namestring
test_case_countinteger
created_byobject
created_atdatetime
updated_atdatetime
app_idstring or nullOptional

App this suite is bound to, or null for a workspace-level suite.

descriptionstring or nullOptional
variableslist of objectsOptionalDefaults to []
global_guardrailslist of stringsOptionalDefaults to []
test_caseslist of objectsOptionalDefaults to []
updated_byobject or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error