Bulk Fetch Test Cases

Request

{
  "projectId": 43
}

Response

{
  "data": [
    {
      "tcID": 7,
      "entityKey": "1FHB-TC-6",
      "summary": "User Login Scenario",
      "description": "Verify user login with valid credentials",
      "tcVersion": 2,
      "tcVersionID": 7,
      "priority": 100,
      "priorityAlias": "P2",
      "testCaseStateAlias": "Open",
      "testCaseStateLabel": "Open",
      "testCaseTypeAlias": "Functional",
      "testingTypeAlias": "Manual",
      "componentAlias": "Comp1,Comp2",
      "ownerAlias": "admin",
      "executionMinutes": "270",
      "isArchived": false,
      "isShared": false,
      "projectId": 43,
      "projectName": "QMetry",
      "folderPath": "/Project-1/folder1 : /Project-1/folder2",
      "folderMappings": [
        { "folderPath": "/Project-1/folder1", "tcFolderID": 46 },
        { "folderPath": "/Project-1/folder2", "tcFolderID": 47 }
      ],
      "createdBy": "admin",
      "createdDate": "10-11-2023 03:53:33 PM",
      "updatedBy": "admin",
      "updatedDate": "10-11-2023 04:33:30 PM",
      "lookuplistdemo": "New"
    }
  ],
  "pagination": {
    "hasMore": true,
    "next": "e4ebf0628dc29626f2e7d239a9b4aa2a"
  }
}

Send the cursor from pagination.next of the previous response as the top level next parameter. Do not resend filters, because the cursor already carries them.

Request

{
  "projectId": 43,
  "next": "e4ebf0628dc29626f2e7d239a9b4aa2a"
}

Response

{
  "data": [
    { "tcID": 664, "entityKey": "1FHB-TC-664" },
    { "tcID": 665, "entityKey": "1FHB-TC-665" }
  ],
  "pagination": {
    "hasMore": true,
    "next": "83501e16ec57d283917fb7272cf331a0"
  }
}

When a request contains both next and filters, the filters embedded in the cursor apply and the filters in the request body are ignored. In this example, the cursor was produced by a first page filtered on isArchived set to false, so every row is active even though the request body asks for archived test cases.

Request

{
  "projectId": 43,
  "next": "e4ebf0628dc29626f2e7d239a9b4aa2a",
  "filters": {
    "isArchived": true
  }
}

Response

{
  "data": [
    { "tcID": 664, "isArchived": false },
    { "tcID": 665, "isArchived": false }
  ],
  "pagination": {
    "hasMore": true,
    "next": "83501e16ec57d283917fb7272cf331a0"
  }
}

Pass one or more priority labels as an array. Every returned test case matches at least one of the supplied labels.

Request

{
  "projectId": 43,
  "filters": {
    "priorityAlias": ["Blocker"]
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-6", "priorityAlias": "Blocker" },
    { "entityKey": "1FHB-TC-20", "priorityAlias": "Blocker" }
  ],
  "pagination": { "hasMore": false }
}

Set isArchived to false to return active test cases, or true to return archived test cases only.

Request

{
  "projectId": 43,
  "filters": {
    "isArchived": false
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-6", "isArchived": false }
  ],
  "pagination": {
    "hasMore": true,
    "next": "8123620a73cb2e32d80d08f32cc19c4b"
  }
}

Set isShared to true to return shared test cases, or false to return test cases that are not shared.

Request

{
  "projectId": 43,
  "filters": {
    "isShared": false
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-6", "isShared": false }
  ],
  "pagination": {
    "hasMore": true,
    "next": "5d1f0a9c2b7e4d38a6c1f09e7b3a2d54"
  }
}

Use an asterisk anywhere in the value for prefix, suffix, or substring matching. The value tc1* matches summaries such as tc1 and tc1_login.

Request

{
  "projectId": 43,
  "filters": {
    "summary": "tc1*"
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-6", "summary": "tc1" }
  ],
  "pagination": { "hasMore": false }
}

Returns only the listed test cases. Because the result set is limited to the supplied identifiers, hasMore is always false. You can send up to 500 identifiers per request. For a larger set, split the identifiers across several requests.

Request

{
  "projectId": 43,
  "filters": {
    "tcIds": [7, 165]
  }
}

Response

{
  "data": [
    { "tcID": 7, "entityKey": "1FHB-TC-6" },
    { "tcID": 165, "entityKey": "1FHB-TC-20" }
  ],
  "pagination": { "hasMore": false }
}

Pass both dates in YYYY-MM-DD format. Both boundary dates are included in the results.

Request

{
  "projectId": 43,
  "filters": {
    "createdDateFrom": "2025-07-01",
    "createdDateTo": "2025-07-31"
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-20", "createdDate": "07-30-2025 10:39:39 AM" }
  ],
  "pagination": { "hasMore": false }
}

Pass a fields array to receive only the listed columns. The priority field returns the numeric identifier of the priority list value, not the label. To get the label, request priorityAlias.

Request

{
  "projectId": 43,
  "fields": ["entityKey", "summary", "priority"]
}

Response

{
  "data": [
    { "tcID": 7, "entityKey": "1FHB-TC-6", "summary": "tc1", "priority": 12345 }
  ],
  "pagination": {
    "hasMore": true,
    "next": "b7c2e19f04a36d58e1f2a9c07d4b3e61"
  }
}

Add the user defined field name to fields. When the field holds no value for a test case, the key is omitted from that row, as in the first row of this response.

Request

{
  "projectId": 43,
  "fields": ["entityKey", "summary", "lookuplistdemo"]
}

Response

{
  "data": [
    { "tcID": 7, "entityKey": "1FHB-TC-6", "summary": "tc1" },
    { "tcID": 165, "entityKey": "1FHB-TC-20", "summary": "root", "lookuplistdemo": "New" }
  ],
  "pagination": {
    "hasMore": true,
    "next": "c91d3a7e25f06b48d2e1a0f93c7b5d82"
  }
}

Replace plannedDate with the name of a DATETIMEPICKER user defined field configured in your project. The value is returned in the date and time format of the API key user. When the field holds no value for a test case, the key is omitted from that row.

Request

{
  "projectId": 57,
  "fields": ["entityKey", "summary", "plannedDate"]
}

Response

{
  "data": [
    { "tcID": 155, "entityKey": "KEV1-TC-1", "summary": "Testcase_1", "plannedDate": "04-23-2025 06:30:00 PM" },
    { "tcID": 156, "entityKey": "KEV1-TC-2", "summary": "Test_2", "plannedDate": "03-25-2025 06:30:00 PM" }
  ],
  "pagination": { "hasMore": false }
}

Use the field name as the key and the display label of the list value as the value.

Request

{
  "projectId": 43,
  "filters": {
    "lookuplistdemo": "New"
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-20", "lookuplistdemo": "New" }
  ],
  "pagination": { "hasMore": false }
}

Pass the values as an array. The values are evaluated as OR, so the following request returns every test case that holds either value, or both.

Request

{
  "projectId": 43,
  "filters": {
    "multilookfield6": ["CC", "BB"]
  }
}

Response

{
  "data": [
    { "entityKey": "1FHB-TC-7", "multilookfield6": "BB,CC" },
    { "entityKey": "1FHB-TC-32", "multilookfield6": "Alpha,BB,Beta,CC,Gamma" },
    { "entityKey": "1FHB-TC-37", "multilookfield6": "Alpha,CC,Gamma" }
  ],
  "pagination": { "hasMore": false }
}

Replace plannedDate with the name of a DATETIMEPICKER user defined field configured in your project. The value must be an object with from and to dates in YYYY-MM-DD format. Both boundary dates are included, so test cases 163 and 156, which fall on the boundary dates, appear in the results. Test case 155, planned for April 23, 2025, falls outside the range and is excluded.

Request

{
  "projectId": 57,
  "filters": {
    "plannedDate": {
      "from": "2025-03-16",
      "to": "2025-03-25"
    }
  }
}

Response

{
  "data": [
    { "tcID": 156, "entityKey": "KEV1-TC-2", "plannedDate": "03-25-2025 06:30:00 PM" },
    { "tcID": 158, "entityKey": "KEV1-TC-4", "plannedDate": "03-17-2025 06:30:00 PM" },
    { "tcID": 163, "entityKey": "KEV1-TC-9", "plannedDate": "03-16-2025 06:30:00 PM" }
  ],
  "pagination": { "hasMore": false }
}

Send tsId to return only the test cases linked to that test suite. The fields array continues to apply.

Request

{
  "projectId": 43,
  "tsId": 101,
  "fields": ["tcID", "summary", "status"]
}

Response

{
  "data": [
    { "tcID": 11, "summary": "Login smoke", "status": "Draft" }
  ],
  "pagination": {
    "hasMore": true,
    "next": "3mK9vXpL8QrN2wYtA0bDcEfGhIjKlMnOpQrStUvWxYz1234ABCD=="
  }
}

Request for the next page. The cursor carries the test suite scope, so do not resend tsId. If you send a different tsId together with the cursor, it is ignored, and the response still contains test cases from test suite 101.

{
  "projectId": 43,
  "next": "3mK9vXpL8QrN2wYtA0bDcEfGhIjKlMnOpQrStUvWxYz1234ABCD=="
}

Response

{
  "data": [
    { "tcID": 511, "summary": "Checkout smoke" }
  ],
  "pagination": {
    "hasMore": true,
    "next": "7pQwRmLkNvBcYdZaJhUeGfTyOi9sXwQp0An8E3uCjMrVb6KDlFhS=="
  }
}

Any filters sent alongside tsId are discarded without warning. The response contains every test case in the test suite, archived and active, across all statuses.

Request

{
  "projectId": 43,
  "tsId": 101,
  "filters": {
    "isArchived": true,
    "status": "Draft"
  }
}

Response

{
  "data": [
    { "tcID": 11, "isArchived": false, "status": "Approved" },
    { "tcID": 15, "isArchived": true, "status": "Approved" }
  ],
  "pagination": { "hasMore": false }
}

{
  "error": "projectId is required"
}

{
  "error": "Invalid or expired pagination cursor"
}

{
  "message": "tsId 9999 does not belong to project 43",
  "status": 400
}

{
  "error": "Unknown field: nonExistentField99"
}

{
  "error": "tcIds filter cannot exceed 500 entries per request"
}

{
  "error": "Access denied to project: 99999999"
}