Skip to main content
GET
/
test-plans
curl -X GET "https://nunu.ai/api/v1/test-plans?search=smoke&sort_by=name&page=0&page_size=10" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "data": [
    {
      "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
      "project_id": "test",
      "name": "Smoke Tests",
      "test_count": 5,
      "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"
    },
    {
      "id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
      "project_id": "test",
      "name": "Smoke Tests - Mobile",
      "test_count": 3,
      "created_at": "2026-03-05T12:00:00.000000+00:00",
      "created_by": "user@example.com",
      "modified_at": "2026-03-10T09:15:00.000000+00:00",
      "modified_by": "user@example.com"
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 10,
    "total_count": 2,
    "total_pages": 1
  }
}

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 paginated list of test plans for your project.

​
Query Parameters

​
search
string
Search by test plan name
​
sort_by
string
default:"name"
Field to sort by: name, test_count, modified_at, or created_at
​
sort_order
string
default:"asc"
Sort direction: asc or desc
​
page
integer
default:"0"
Page number (0-indexed)
​
page_size
integer
default:"20"
Results per page (1-100)

​
Response

​
data
TestPlanSummary[]
required
Array of test plan summary objects
​
pagination
object
required
Pagination information

​
TestPlanSummary Object

​
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
​
test_count
integer
required
Number of tests in the plan
​
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
curl -X GET "https://nunu.ai/api/v1/test-plans?search=smoke&sort_by=name&page=0&page_size=10" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "data": [
    {
      "id": "b3f1a2c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c",
      "project_id": "test",
      "name": "Smoke Tests",
      "test_count": 5,
      "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"
    },
    {
      "id": "c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
      "project_id": "test",
      "name": "Smoke Tests - Mobile",
      "test_count": 3,
      "created_at": "2026-03-05T12:00:00.000000+00:00",
      "created_by": "user@example.com",
      "modified_at": "2026-03-10T09:15:00.000000+00:00",
      "modified_by": "user@example.com"
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 10,
    "total_count": 2,
    "total_pages": 1
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication

Query Parameters

​
search
string

Search by test plan name

​
sort_by
enum<string>
default:name

Field to sort by

Available options:
name,
test_count,
modified_at,
created_at
​
sort_order
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
​
page
integer
default:0

Page number (0-indexed)

​
page_size
integer
default:20

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

​
data
object[]
​
pagination
object