Get Project

Retrieve details of a specific project

GET /api/trpc/projects.get

Get Project

cURL

curl --request GET \
  --url https://api.example.com/api/trpc/projects.get

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "settings": {
    "base_url": "<string>",
    "default_timeout": 123,
    "environment": "<string>",
    "viewport": {}
  },
  "tags": [
    {}
  ],
  "stats": {
    "total_tests": 123,
    "passing_tests": 123,
    "failing_tests": 123,
    "last_run_at": "<string>"
  },
  "404 Not Found": {},
  "401 Unauthorized": {}
}

Query Parameters

batch · number · required

Must be set to 1 for tRPC batch requests

input · object · required

Show properties

project_id · string · required

The unique identifier of the project to retrieve

Response

id · string

The unique identifier of the project

name · string

The name of the project

description · string

The project description

created_at · string

ISO 8601 timestamp of when the project was created

updated_at · string

ISO 8601 timestamp of when the project was last updated

settings · object

Show properties

base_url · string

The base URL of the application being tested

default_timeout · integer

Default timeout in seconds for test executions

environment · string

Target environment

viewport · object

Browser viewport settings

tags · array

List of project tags

stats · object

Show properties

total_tests · integer

Total number of tests in the project

passing_tests · integer

Number of passing tests

failing_tests · integer

Number of failing tests

last_run_at · string

ISO 8601 timestamp of the last test run

Example Request

curl "https://api.tryiris.dev/api/trpc/projects.get?batch=1&input=%7B%22project_id%22%3A%22prj_9a8b7c6d5e%22%7D" \
  -H "Authorization: Bearer ${API_KEY}"

Example Response

{
  "0": {
    "result": {
      "data": {
        "id": "prj_9a8b7c6d5e",
        "name": "e-commerce-testing",
        "description": "End-to-end testing for our e-commerce platform",
        "created_at": "2024-01-20T11:00:00Z",
        "updated_at": "2024-01-20T11:30:00Z",
        "settings": {
          "base_url": "https://shop.example.com",
          "default_timeout": 45,
          "environment": "staging",
          "viewport": {
            "width": 1920,
            "height": 1080
          }
        },
        "tags": ["e-commerce", "web", "staging"],
        "stats": {
          "total_tests": 25,
          "passing_tests": 23,
          "failing_tests": 2,
          "last_run_at": "2024-01-20T11:15:00Z"
        }
      }
    }
  }
}

Error Responses

404 Not Found · object

Project not found

{
  "error": "not_found",
  "message": "Project not found"
}

401 Unauthorized · object

Missing or invalid API key

{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}