Skip to main content
GET
/
test-plans
/
{testPlanId}
curl -X GET "https://nunu.ai/api/v1/test-plans/b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c" \
  -H "X-Api-Key: YOUR_API_TOKEN"
{
  "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "project_id": "test",
  "name": "Smoke Tests",
  "created_at": "2026-03-01T10:00:00.000000+00:00",
  "created_by": "user@example.com",
  "modified_at": "2026-03-15T14:30:00.000000+00:00",
  "modified_by": "user@example.com",
  "test_items": [
    {
      "multiplayer_test_id": "a5060a07-d386-4269-98ce-b33fb894201e",
      "retries": 0
    },
    {
      "multiplayer_test_id": "c7080b09-e498-5381-a0df-d55fb006413f",
      "retries": 2
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.nunu.ai/llms.txt

Use this file to discover all available pages before exploring further.

Permission Required: project:read-runs
Retrieve a specific test plan by ID, including its test items.
curl -X GET "https://nunu.ai/api/v1/test-plans/b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c" \
  -H "X-Api-Key: YOUR_API_TOKEN"

Response

id
string
required
Unique identifier for the test plan
project_id
string
required
Project the test plan belongs to
name
string
required
Test plan name
created_at
string
ISO 8601 timestamp when the test plan was created
created_by
string
Who created the test plan
modified_at
string
ISO 8601 timestamp when the test plan was last modified
modified_by
string
Who last modified the test plan
test_items
TestItem[]
required
Ordered list of tests in this plan
{
  "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
  "project_id": "test",
  "name": "Smoke Tests",
  "created_at": "2026-03-01T10:00:00.000000+00:00",
  "created_by": "user@example.com",
  "modified_at": "2026-03-15T14:30:00.000000+00:00",
  "modified_by": "user@example.com",
  "test_items": [
    {
      "multiplayer_test_id": "a5060a07-d386-4269-98ce-b33fb894201e",
      "retries": 0
    },
    {
      "multiplayer_test_id": "c7080b09-e498-5381-a0df-d55fb006413f",
      "retries": 2
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

testPlanId
string<uuid>
required

The test plan ID (UUID)

Response

Successful response

id
string<uuid>

Unique identifier for the test plan

project_id
string<uuid>

Project the test plan belongs to

name
string

Test plan name

created_at
string<date-time> | null
created_by
string | null
modified_at
string<date-time> | null
modified_by
string | null
test_items
object[]

Ordered list of tests in this plan