Cases and steps API

The Cases and steps API lets you read, create and update test cases and their steps in a Qualflare project over REST at https://api.qualflare.com/api/v1, authenticated with a project access token.

The eight endpoints, each with its own section below:

List a suite's cases

List a suite's cases returns every case of one suite that matches your filters.

GET /api/v1/suite/{suiteSeq}/cases

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/cases?state=active&state=draft" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: items and total: every matching case of the suite, with no pages.

• The answer is items and total, every matching case in the suite, with no pages.
• suiteName is empty in this list; Get a case fills it in.

Get a case

Get a case returns one test case by its number.

GET /api/v1/case/{caseSeq}

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

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

Returns 200: The case.

{
  "seq": 101,
  "position": 4,
  "uid": "User can apply a coupon at checkout",
  "name": "User can apply a coupon at checkout",
  "description": "A 10% coupon lowers the order total before tax.",
  "state": "active",
  "priority": "high",
  "testType": "e2e",
  "automation": "manual",
  "isFavorite": false,
  "isFlaky": false,
  "flakyScore": 0,
  "mark": "none",
  "isArchived": false,
  "suiteSeq": 12,
  "suiteName": "Checkout",
  "createdAt": "2026-09-14T08:40:12Z",
  "updatedAt": "2026-10-21T16:05:57Z"
}

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

Create a case

Create a case adds a test case to a suite and sets only its name.

POST /api/v1/suite/{suiteSeq}/cases

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

curl -sS -X POST "https://api.qualflare.com/api/v1/suite/12/cases" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "User can reset a forgotten password"}'

Returns 201: The new case.

• Only name is set (1 to 255 characters); the case starts as a Draft, Low-priority, E2E, manual case. Set the rest with Update a case.
• A name already in the suite answers 409.
• Each case counts toward your plan's test cases; at the limit the API answers 402 with Test Cases quota exceeded (<used>/<limit>).

Update a case

Update a case changes the name, description, state or priority of a test case.

PUT /api/v1/case/{caseSeq}

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/case/101" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"state": "active", "priority": "high"}'

Returns 200: The updated case.

• Send only the fields to change: name, description (up to 1,024 characters; longer text fails to save), state, priority.
• A body with none of them changes nothing and returns the case.

Create cases in bulk

Create cases in bulk adds up to 20 test cases to one suite in one request.

POST /api/v1/suite/{suiteSeq}/cases/bulk

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

curl -sS -X POST "https://api.qualflare.com/api/v1/suite/12/cases/bulk" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cases": [{"title": "Reset link expires after one hour", "priority": "high"}, {"title": "Reset link works only once"}]}'

Returns 201: suiteSeq, count and caseSeqs, the numbers of the new cases.

• 1 to 20 cases, each with a title of 5 to 255 characters, an optional description (up to 1,024 characters; longer text fails to save) and an optional priority (default medium). They start as Draft, Unit, manual cases.
• All or none: if the batch would pass your plan's test-case limit, nothing is created.
• The answer is suiteSeq, count and caseSeqs.

List a case's steps

List a case's steps returns an array of every step of the case, in order; a shared step carries sharedStep with its own items.

GET /api/v1/case/{caseSeq}/steps

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

curl -sS "https://api.qualflare.com/api/v1/case/101/steps" \
  -H "Authorization: Bearer $QF_TOKEN"

Returns 200: An array of every step of the case, in order.

Add a step

Add a step appends a step to a test case.

POST /api/v1/case/{caseSeq}/steps

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

curl -sS -X POST "https://api.qualflare.com/api/v1/case/101/steps" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"instruction": "Open the sign-in page", "stepType": "navigation"}'

Returns 201: The new step.

• instruction is required, up to 500 characters; stepType defaults to action; parentId nests the step under another; data is any JSON.

Update a step

Update a step changes the instruction, stepType or data you send.

PUT /api/v1/case/{caseSeq}/step/{id}

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/case/101/step/7" \
  -H "Authorization: Bearer $QF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"instruction": "Open /login"}'

Returns 200: The updated step.

• A step id that isn't on the case answers 404 with step not found.

Case fields

Every case the Cases and steps API returns has these fields:

Step fields

Every step in List a case's steps, and the step a write returns, has these fields:

CLI and MCP equivalents

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

Related

• Guides: Create and edit test cases
• Reference: Test cases: fields, states and steps · Suites API
• CLI/API: Qualflare API · Errors and status codes