Projects API

Manage your Testably projects programmatically. List, create, update, and delete projects.

Base URL:https://api.testably.app/v1

GET/v1/projects

Returns a list of all projects accessible to the authenticated user. Results are sorted by most recently updated.

Response

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "Mobile App QA",
      "prefix": "MOB",
      "test_case_count": 142,
      "run_count": 38,
      "created_at": "2025-12-01T09:00:00Z",
      "updated_at": "2026-03-28T14:22:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20
  }
}

GET/v1/projects/:id

Retrieve a single project by its ID, including summary statistics and configuration details.

Response

{
  "data": {
    "id": "proj_abc123",
    "name": "Mobile App QA",
    "prefix": "MOB",
    "description": "QA test suite for the mobile application",
    "test_case_count": 142,
    "run_count": 38,
    "member_count": 5,
    "created_at": "2025-12-01T09:00:00Z",
    "updated_at": "2026-03-28T14:22:00Z"
  }
}

POST/v1/projectsComing Soon

Create a new project. The prefix is used for generating test case IDs (e.g., MOB-1, MOB-2).

Parameters

Name	Type	Required	Description
`name`	string	Required	Display name for the project
`prefix`	string	Required	Short prefix for test case IDs (2-5 uppercase letters)

Request Body

{
  "name": "Mobile App QA",
  "prefix": "MOB"
}

Response

{
  "data": {
    "id": "proj_abc123",
    "name": "Mobile App QA",
    "prefix": "MOB",
    "test_case_count": 0,
    "run_count": 0,
    "member_count": 1,
    "created_at": "2026-03-29T10:00:00Z",
    "updated_at": "2026-03-29T10:00:00Z"
  }
}

PATCH/v1/projects/:idComing Soon

Update an existing project. Only provided fields will be modified.

Parameters

Name	Type	Required	Description
`name`	string	Optional	New display name
`description`	string	Optional	Project description

Request Body

{
  "name": "Mobile App QA - v2",
  "description": "Updated QA suite for mobile v2"
}

Response

{
  "data": {
    "id": "proj_abc123",
    "name": "Mobile App QA - v2",
    "prefix": "MOB",
    "description": "Updated QA suite for mobile v2",
    "updated_at": "2026-03-29T11:00:00Z"
  }
}

DELETE/v1/projects/:idComing Soon

Permanently delete a project and all its associated test cases, runs, and results. This action cannot be undone.

Response

{
  "message": "Project deleted successfully"
}

Authentication Test Cases API