Skip to main content
GET
List test entities
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Path Parameters

project_id
string
required

Id of the project. You can get project_id by listing your projects using the List projects API.

Example:

"pdqmxlz"

run_id
string
required

Id of the run. You can get run_id by listing runs using the List runs API.

Example:

"kftwnab"

Query Parameters

kind
enum<string>
default:spec

Kind of test entity to list. Defaults to spec.

Available options:
spec,
test
Example:

"spec"

status
enum<string>[]

Filter by status. Accepts one or more statuses as a comma-separated list.

Available options:
passed,
failed,
skipped,
interrupted,
timed_out,
flaky
Example:
page_number
integer
default:1

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

Example:

1

page_size
integer

Number of records returned per page. Each endpoint applies its own default and maximum value.

Example:

15

Response

200 - application/json

OK - Request succeeded. Defaults to 25 test entities per page (maximum 100).

test_entities
object[]
pagination
object