Suites API

The Suites API lets you list and read test suites, and analyze and save their coverage score, in a Qualflare project over REST at https://api.qualflare.com/api/v1/suites, authenticated with a project access token.

The four endpoints, each with its own section below:

List suites

List suites returns one page of the project's test suites, searched and sorted as you ask.

GET /api/v1/suites

Needs a project access token whose creator has the Viewer role or higher in the project.

curl -sS "https://api.qualflare.com/api/v1/suites?page=1" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: A page of suites: items and paging, 20 suites per page.

Get a suite

Get a suite returns one suite by its number.

GET /api/v1/suite/{suiteSeq}

Needs a project access token whose creator has the Viewer role or higher in the project.

curl -sS "https://api.qualflare.com/api/v1/suite/12" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: The suite.

{
  "seq": 12,
  "name": "Checkout",
  "description": "Cart, coupons and payment",
  "priority": "high",
  "automation": "automated",
  "testType": "playwright",
  "coverageScore": 82,
  "caseCount": 48,
  "teamSeq": 2,
  "teamName": "Payments",
  "isArchived": false,
  "createdAt": "2026-08-03T10:15:00Z",
  "updatedAt": "2026-10-28T14:02:41Z"
}

• A number that isn't a suite of the project answers 404 with suite not found.

Analyze a suite's coverage

Analyze a suite's coverage scores the suite's test cases by test type, priority, quality and completeness, and returns the score with recommendations.

GET /api/v1/suite/{suiteSeq}/coverage-analysis

Needs a project access token whose creator has the Viewer role or higher in the project.

curl -sS "https://api.qualflare.com/api/v1/suite/12/coverage-analysis" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: The coverage analysis. Nothing is saved.

• It saves nothing, and each call counts toward your plan's monthly coverage analyses All plans (available on Starter, Core, Scale, Enterprise, Open Source); at the quota it answers 402 with Coverage Analysis quota exceeded (<used>/<limit>).
• Any reader can run it; canAttachScore says whether your token may save the score.

Save a coverage score

Save a coverage score stores a 0 to 100 coverage score on the suite.

PUT /api/v1/suite/{suiteSeq}/coverage-score

Needs a project access token created with Allow writes, whose creator has the Editor role or higher in the project.

curl -sS -X PUT "https://api.qualflare.com/api/v1/suite/12/coverage-score" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"coverageScore": 82, "reason": "Checked after the release"}'

Returns 200: The updated suite.

• coverageScore is required, 0 to 100 (0 is a valid score); reason is optional, up to 512 characters.
• It is not counted against the coverage quota, and it is recorded in the suite's coverage history.

Suite fields

Every suite the Suites API returns has these fields, in list items and in Get a suite:

Coverage analysis fields

The answer of Analyze a suite's coverage has these fields:

CLI and MCP equivalents

The qf CLI and the MCP server run the same reads, and the MCP server the same write, so they return the same JSON:

Related

• Guides: Test suites and Browse
• Reference: Cases and steps API · Errors and status codes
• CLI/API: Qualflare API · MCP server reference