The Test Project (Git) object

The test-project and git resources refers to Git projects.

Use the test-project resource to access Git project information using simple query or by using advance filters, get the latest test suite collections in a Git project, or delete a specific Git project.

Use the test resource to create a new Git project, update an existing one.


Request input

Refer to the dependency issue when adding additional query parameters in your HTTP request: Find test project ID


To learn more about Git projects, see the following documentation: Organizing tests.

Response body sample

  "id": 517169,
  "name": "ci-samples",
  "description": "",
  "projectId": 934901,
  "createdAt": "2023-01-05T07:05:21.399+0000",
  "type": "GIT",
  "gitRepository": {
    "id": 316592,
    "testProjectId": 517169,
    "repository": "",
    "branch": "refs/heads/update-gitlab-sample",
    "username": "[email protected]",
    "password": "",
    "createdAt": "2023-01-05T07:05:21.399+0000",
    "vcsType": "GITLAB",
    "shouldMergeTestResultsForNewScriptRepo": false
  "testSuiteCollections": [
      "id": 354022,
      "name": "Test Suites/Advanced/TS_RegressionTestCollectionParallel",
      "urlId": "354022-Test Suites/Advanced/TS_RegressionTestCollectionParallel"
      "id": 354023,
      "name": "Test Suites/TS_RegressionTestCollection",
      "urlId": "354023-Test Suites/TS_RegressionTestCollection"
  "dirty": false

Refer to the following table about the response body parameters:

idintegerThe unique identifier of the test project.
namestringThe test project name.
descriptionstringThe test project description.
projectIdintegerThe unique identifier of the associated Katalon project.
createdAtdate-timeThe date and time when the test project was configured.
typestringThe script repository type: GIT (for Git-based) or KS (for non-Git).
gitRepositorygit repository objectThe object that describes the Git repository attached to the test project.
testSuiteCollectionsarray of test suite collection objectsThe test suite collections that the test project stores.