Get Test

Retrieve details of a specific test by ID

GET /api/trpc/test.findFirst

Get Test

cURL

curl --request GET \
  --url https://app.tryiris.dev/api/trpc/test.findFirst \
  --header 'IRIS_ACCESS_TOKEN: <iris_access_token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "naturalLanguageInput": "<string>",
  "status": "<string>",
  "isActive": true,
  "projectId": "<string>",
  "createdById": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "project": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "cookies": {},
    "session": {},
    "localStorage": {}
  },
  "createdBy": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "pictureUrl": "<string>",
    "status": "<string>",
    "globalRole": "<string>"
  }
}

Get Test Details

Retrieve detailed information about a specific test, including its project and creator details.

Headers

IRIS_ACCESS_TOKEN · string · required

Your Iris API access token

Query Parameters

batch · number · required

Must be set to 1 for TRPC compatibility

input · object · required

The query input parameters

Show Input Object Properties

where · object · required

id · string · required

The unique identifier of the test to retrieve

include · object

project · boolean

Include project details

createdBy · boolean

Include creator details

Response

Returns the test details along with included relations if specified.

id · string

Unique identifier of the test

name · string

Name of the test

description · string

Description of the test

url · string

Target URL for the test

naturalLanguageInput · string

Test steps in natural language format

status · string

Current status of the test (e.g., “DRAFT”)

isActive · boolean

Whether the test is active

projectId · string

ID of the associated project

createdById · string

ID of the user who created the test

createdAt · date

Timestamp when the test was created

updatedAt · date

Timestamp when the test was last updated

project · object

Project details if included

Show Project Properties

id · string

Project ID

name · string

Project name

description · string

Project description

cookies · object

Project cookies configuration

session · object

Project session configuration

localStorage · object

Project local storage configuration

createdBy · object

Creator details if included

Show Creator Properties

id · string

User ID

name · string

User’s name

email · string

User’s email

pictureUrl · string

URL of user’s profile picture

status · string

User’s status

globalRole · string

User’s global role

Request Example

curl 'https://app.tryiris.dev/api/trpc/test.findFirst?batch=1&input={"where":{"id":"c5147ecb-22d0-4704-9a30-932ebf28302f"},"include":{"project":true,"createdBy":true}}' \
  -H 'Authorization: Bearer <your-iris-token>' \
  -X GET