API Endpoints

Bulk Import

post

Path parameters

handlestringRequired

keystringRequired

Body

Responses

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/data HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 385

{
  "entities": {
    "executions": {
      "entries": [
        {
          "name": "text",
          "externalIdField": "text",
          "caseRef": "text",
          "runRef": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    },
    "runs": {
      "entries": [
        {
          "name": "text",
          "externalIdField": "text",
          "source": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    },
    "folders": {
      "entries": [
        {
          "name": "text",
          "externalIdField": "text",
          "source": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  }
}

204

No content

No content

Templates

get

Retrieves the list of paginated templates for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

namestringOptional

createdByIdsstring[]Optional

creationStartDatestringOptional

creationEndDatestringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/templates HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new template within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The template data to be created.

namestringRequired

The name of the template.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/templates HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "text",
  "templateFields": [
    {
      "id": "text",
      "name": "text",
      "dataType": "text",
      "defaultValue": "text",
      "value": "text",
      "options": [
        "text"
      ]
    }
  ]
}

200

The newly created template object.

No content

get

Retrieves the details of a specific template within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

idnumber · doubleRequired

The unique identifier for the template.

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/templates/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing template.

namestringOptional

The name of the template.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/templates/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "name": "text",
  "templateFields": [
    {
      "id": "text",
      "name": "text",
      "dataType": "text",
      "defaultValue": "text",
      "value": "text",
      "options": [
        "text"
      ]
    }
  ]
}

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/templates/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "message": "text"
}

Tags

get

Retrieves the list of paginated tags of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

entityTypestringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/tags HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new tag for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

Body

The tag data to be created.

namestringRequired

The name of the tag.

descriptionstringOptional

The description of the tag.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/tags HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "description": "text",
  "entityTypes": [
    "cases"
  ]
}

200

The newly created tag object.

No content

get

Retrieves the details of a specific tag for a user or an organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

idnumber · doubleRequired

The unique identifier for the tag.

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/tags/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing tag.

namestringOptional

The name of the tag.

descriptionstringOptional

The description of the tag.

archivedbooleanOptional

The boolean flag to archive/unarchive a tag.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/tags/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "name": "text",
  "description": "text",
  "entityTypes": [
    "cases"
  ],
  "archived": true
}

200

Ok

No content

delete

Path parameters

handlestringRequired

idnumber · doubleRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/tags/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "success": true
}

Shared Steps

get

Retrieves the list of paginated shared steps for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/shared-steps HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new shared step within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The shared step data to be created.

namestringRequired

The name of the shared step. This field defines the name or label for the shared step.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/shared-steps HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "name": "text",
  "steps": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "expectedResult": "text",
      "children": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "expectedResult": "text",
          "children": [
            "[Circular Reference]"
          ],
          "sharedStepUid": 1
        }
      ],
      "sharedStepUid": 1
    }
  ]
}

200

The newly created shared step object.

No content

patch

Path parameters

handlestringRequired

keystringRequired

idstringRequired

Body

Data Transfer Object for updating an existing shared step.

namestringOptional

The name of the shared step. Optional field that allows you to update the name or label of the shared step.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/shared-steps/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 258

{
  "name": "text",
  "steps": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "expectedResult": "text",
      "children": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "expectedResult": "text",
          "children": [
            "[Circular Reference]"
          ],
          "sharedStepUid": 1
        }
      ],
      "sharedStepUid": 1
    }
  ]
}

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/shared-steps/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "success": true
}

Test Runs

get

Retrieves the list of paginated test runs for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/runs HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new test run within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The template data to be created.

namestringRequired

The name of the test run. This field defines the name or label of the test run.

casesnumber · double[]Optional

The list of test case IDs to be included in the test run. Optional field that contains an array of test case IDs that should be executed in the test run.

externalIdstringRequired

The external identifier for the test run. This field provides an external reference or ID for the test run, useful for integration with other systems.

sourcestringOptional

The source of the test run. Optional field to specify where the test run originated, such as a specific tool, platform, or system.

prioritynumber · doubleOptional

The priority level of the test run. Optional field that defines the priority for this test run, typically represented as a numeric value (e.g., 1 = high, 2 = medium, 3 = low).

statusnumber · doubleOptional

The status of the test run. Optional field that represents the current status of the test run, such as pending, running, completed, etc.

milestoneUidsnumber · double[]Optional

The milestone UIDs associated with the test run. Optional field that links the test run to one or more milestones, allowing the test run to be associated with a specific point in a project or product timeline.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/runs HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "name": "text",
  "cases": [
    1
  ],
  "externalId": "text",
  "source": "text",
  "customFields": {
    "configs": [
      "text"
    ],
    "tags": [
      "text"
    ],
    "selectedCases": [
      1
    ],
    "caseCount": 1,
    "progress": 1,
    "frequency": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "externalFields": null
  },
  "priority": 1,
  "status": 1,
  "milestoneUids": [
    1
  ]
}

200

The newly created test run object.

No content

get

Retrieves the details of a specific test run within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

idnumber · doubleRequired

The unique identifier for the test run.

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/runs/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing test run.

namestringOptional

The name of the test run. Optional field to update the name or label of the test run.

casesnumber · double[]Optional

The list of test case IDs to be included in the test run. Optional field that contains an array of test case IDs to be executed as part of the updated test run.

externalIdstringOptional

The external identifier for the test run. Optional field to update the external reference or ID for the test run, used for integration with external systems.

sourcestringOptional

The source of the test run. Optional field to specify the source or origin of the test run, such as the tool or platform.

prioritynumber · doubleOptional

The priority level of the test run. Optional field to update the priority of the test run, typically represented as a numeric value (e.g., 1 = high, 2 = medium, 3 = low).

statusnumber · doubleOptional

The status of the test run. Optional field to update the current status of the test run, such as pending, running, completed, or failed.

milestoneUidsnumber · double[]Optional

The milestone UIDs associated with the test run. Optional field to update the milestone(s) to which the test run is linked, useful for project tracking.

archivedbooleanOptional

Whether the test run is archived. Optional field to mark the test run as archived or not. This can be used to indicate that the test run is no longer active or relevant.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/runs/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "name": "text",
  "cases": [
    1
  ],
  "externalId": "text",
  "source": "text",
  "customFields": {
    "configs": [
      "text"
    ],
    "tags": [
      "text"
    ],
    "selectedCases": [
      1
    ],
    "caseCount": 1,
    "progress": 1,
    "frequency": {
      "ANY_ADDITIONAL_PROPERTY": 1
    },
    "externalFields": null
  },
  "priority": 1,
  "status": 1,
  "milestoneUids": [
    1
  ],
  "archived": true
}

200

Ok

No content

Test Plans

get

Retrieves the list of paginated test plans for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

statusnumber · doubleOptional

prioritynumber · doubleOptional

archivedbooleanRequired

minRunCountnumber · doubleRequired

maxRunCountnumber · doubleOptional

minCreatedAtstringRequired

maxCreatedAtstringOptional

minProgressnumber · doubleRequired

maxProgressnumber · doubleOptional

limitnumber · doubleRequired

offsetnumber · doubleRequired

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/plans HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new test plan within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The plan data to be created.

namestringRequired

The name of the plan. This field defines the name or title of the plan.

descriptionstringOptional

A brief description of the plan. Optional field that provides additional context or information about the plan.

milestoneUidsnumber · double[]Optional

The milestone UIDs associated with the plan. Optional field that links the plan to one or more milestones. Milestones represent significant points in the project or timeline.

statusnumber · doubleOptional

The status of the plan. Optional field that defines the current state of the plan, such as pending, active, or completed, usually represented as a numeric value.

prioritynumber · doubleOptional

The priority level of the plan. Optional field that represents the priority of the plan, typically represented as a numeric value (e.g., 1 = high, 2 = medium, 3 = low).

externalIdstringOptional

The external identifier for the plan. Optional field to reference the plan externally, useful for integration with other systems or tools.

sourcestringOptional

The source of the plan. Optional field that provides information about the origin of the plan, such as the tool or platform from which it was created.

projectUidnumber · doubleRequired

The project UID associated with the plan. This field identifies the project to which the plan belongs. It is a required field as each plan is tied to a specific project.

tagUidsnumber · double[]Optional

The tag UIDs associated with the plan. Optional field to specify the tags linked to the plan. Tags help categorize or label the plan for better organization and filtering.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/plans HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 426

{
  "name": "text",
  "description": "text",
  "milestoneUids": [
    1
  ],
  "status": 1,
  "priority": 1,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "externalId": "text",
  "source": "text",
  "projectUid": 1,
  "testRuns": [
    {
      "configuration": {
        "type": "matrix",
        "sets": [
          [
            "browser:firefox",
            "browser:safari"
          ],
          [
            "os:windows",
            "os:mac"
          ]
        ]
      },
      "uid": 1
    }
  ],
  "configuration": {
    "type": "matrix",
    "sets": [
      [
        "browser:firefox",
        "browser:safari"
      ],
      [
        "os:windows",
        "os:mac"
      ]
    ]
  },
  "tagUids": [
    1
  ]
}

200

The newly created plan object.

No content

get

Retrieves the details of a specific test plan within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

idstringRequired

The unique identifier for the test plan.

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/plans/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing plan.

namestringOptional

The name of the plan. Optional field to update the name or title of the plan.

descriptionstringOptional

A brief description of the plan. Optional field to update the description, providing additional context or details about the plan.

tagUidsnumber · double[]Optional

The tag UIDs associated with the plan. Optional field to update the tags linked to the plan. Tags help categorize or label the plan for easier organization.

milestoneUidsnumber · double[]Optional

The milestone UIDs associated with the plan. Optional field to update the milestones linked to the plan. Milestones represent key points in the project or timeline.

runUidsnumber · double[]Optional

The run UIDs associated with the plan. Optional field to update the test runs included in the plan. These are the specific runs that are part of the plan's execution.

statusnumber · doubleOptional

The status of the plan. Optional field to update the current state of the plan, such as pending, active, or completed, typically represented by a numeric value.

prioritynumber · doubleOptional

The priority level of the plan. Optional field to update the priority of the plan, generally represented as a numeric value (e.g., 1 = high, 2 = medium, 3 = low).

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/plans/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "name": "text",
  "description": "text",
  "tagUids": [
    1
  ],
  "milestoneUids": [
    1
  ],
  "runUids": [
    1
  ],
  "status": 1,
  "priority": 1
}

200

Ok

No content

Milestones

get

Retrieves the list of paginated milstones for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/milestones HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new test milestone within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The test milestone data to be created.

namestringRequired

The name of the milestone. A string representing the title or label of the milestone.

descriptionstringOptional

The description of the milestone. Optional field that provides additional details or context about the milestone.

startDatestringRequired

The start date of the milestone. A string in ISO 8601 format representing the start date of the milestone (e.g., "2025-03-01T00:00:00Z").

dueAtstringRequired

The due date of the milestone. A string in ISO 8601 format representing the due date or deadline for the milestone (e.g., "2025-04-01T00:00:00Z").

statusnumber · doubleRequired

The status of the milestone. A number representing the current status of the milestone (e.g., 1 for "In Progress", 2 for "Completed").

planIdsnumber · double[]Required

The IDs of the plans associated with the milestone. An array of numbers representing the IDs of the plans linked to the milestone.

runIdsnumber · double[]Required

The IDs of the runs associated with the milestone. An array of numbers representing the IDs of the test runs linked to the milestone.

projectUidnumber · doubleRequired

The project UID to which the milestone belongs. A number representing the unique identifier for the project the milestone is part of.

tagUidsnumber · double[]Optional

The tag UIDs associated with the milestone. Optional field to specify an array of tag IDs for categorizing or labeling the milestone.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/milestones HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "name": "text",
  "description": "text",
  "startDate": "text",
  "dueAt": "text",
  "status": 1,
  "planIds": [
    1
  ],
  "runIds": [
    1
  ],
  "projectUid": 1,
  "tagUids": [
    1
  ]
}

200

The newly created test milestone object.

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

namestringOptional

The name of the milestone. A string representing the title or label of the milestone.

descriptionstringOptional

The description of the milestone. Optional field that provides additional details or context about the milestone.

startDatestringOptional

The start date of the milestone. A string in ISO 8601 format representing the start date of the milestone (e.g., "2025-03-01T00:00:00Z").

dueAtstringOptional

The due date of the milestone. A string in ISO 8601 format representing the due date or deadline for the milestone (e.g., "2025-04-01T00:00:00Z").

statusnumber · doubleOptional

The status of the milestone. A number representing the current status of the milestone (e.g., 1 for "In Progress", 2 for "Completed").

planIdsnumber · double[]Optional

The IDs of the plans associated with the milestone. An array of numbers representing the IDs of the plans linked to the milestone.

runIdsnumber · double[]Optional

The IDs of the runs associated with the milestone. An array of numbers representing the IDs of the test runs linked to the milestone.

projectUidnumber · doubleOptional

The project UID to which the milestone belongs. A number representing the unique identifier for the project the milestone is part of.

tagUidsnumber · double[]Optional

The tag UIDs associated with the milestone. Optional field to specify an array of tag IDs for categorizing or labeling the milestone.

archivedbooleanOptional

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/milestones/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "name": "text",
  "description": "text",
  "startDate": "text",
  "dueAt": "text",
  "status": 1,
  "planIds": [
    1
  ],
  "runIds": [
    1
  ],
  "projectUid": 1,
  "tagUids": [
    1
  ],
  "archived": true
}

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/milestones/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

204

No content

No content

Test Folders

get

Retrieves the list of paginated folders for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization

keystringRequired

The unique identifier for a project

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/folders HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new folder within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The folder data to be created.

namestringRequired

The name of the folder. A string representing the title or label of the folder.

externalIdstringOptional

The external ID of the folder. Optional field to associate the folder with an external identifier, such as from another system or service.

sourcestringOptional

The source of the folder. Optional field to specify the origin or source system of the folder (e.g., "manual", "imported").

parentIdnumber · doubleRequired

The parent ID of the folder. A number representing the unique identifier of the parent folder. Used for nesting folders.

statusnumber · doubleOptional

The status of the folder. Optional field that represents the current status of the folder (e.g., 1 for "Active", 2 for "Archived").

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/folders HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "name": "text",
  "externalId": "text",
  "source": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "parentId": 1,
  "status": 1
}

200

The newly created folder object.

No content

get

Retrieves the details of a specific folder within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization

keystringRequired

The unique identifier for a project

idnumber · doubleRequired

The unique identifier for the folder

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/folders/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing folder.

namestringOptional

The name of the folder. Optional field to update the title or label of the folder.

externalIdstringOptional

The external ID of the folder. Optional field to update the external identifier of the folder.

sourcestringOptional

The source of the folder. Optional field to update the source or origin of the folder.

parentIdnumber · doubleOptional

The parent ID of the folder. Optional field to update the unique identifier of the parent folder, allowing for reorganization of folders.

statusnumber · doubleOptional

The status of the folder. Optional field to update the current status of the folder.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/folders/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "name": "text",
  "externalId": "text",
  "source": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "parentId": 1,
  "status": 1
}

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/folders/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "success": true
}

Test Executions

post

Creates a new test execution within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The execution data to be created.

externalIdstringOptional

The external identifier for the execution. Optional field to specify an external ID for the execution.

sourcestringOptional

The source of the execution. Optional field to specify the source of the execution (e.g., "manual", "automated").

testCaseUidnumber · doubleOptional

The unique identifier of the associated test case. Optional field to link the execution to a specific test case.

testCaseRefnumber · doubleOptional

The reference number for the associated test case. Optional field to provide an reference number for the test case.

testRunUidnumber · doubleOptional

The unique identifier of the associated test run. Optional field to link the execution to a specific test run.

statusnumber · doubleOptional

The status of the execution. Optional field to specify the status of the execution (e.g., "not started", "in progress", "completed").

Responses

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/executions HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "externalId": "text",
  "source": "text",
  "testCaseUid": 1,
  "testCaseRef": 1,
  "testRunUid": 1,
  "status": 1,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "steps": [
    {
      "testStepUid": "text",
      "description": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

204

No content

No content

get

Retrieves the details of a specific test execution within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization

keystringRequired

The unique identifier for a project

idnumber · doubleRequired

The unique identifier for the test execution

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/executions/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing execution.

statusnumber · doubleOptional

The status of the execution. Optional field to specify the status of the execution.

prioritynumber · doubleOptional

The priority of the execution. Optional field to set the priority level of the execution (e.g., high, medium, low).

dueAtstring · date-timeOptional

The due date of the execution. Optional field to set the due date for the execution in ISO 8601 format (e.g., "2025-03-10T12:00:00").

assignedTostringOptional

The user assigned to the execution. Optional field to specify the user responsible for the execution.

tagUidsnumber · double[]Optional

The tag UIDs associated with the execution. Optional field to associate tags with the execution, represented by their unique identifiers.

namestringOptional

The name of the execution. Optional field to update the name or title of the execution.

templateFieldsanyRequired

The template fields for the execution. Required field to update or specify template fields associated with the execution.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/executions/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "status": 1,
  "priority": 1,
  "dueAt": "2025-04-26T08:44:47.382Z",
  "assignedTo": "text",
  "tagUids": [
    1
  ],
  "tagReplacements": [
    {
      "newTagUids": [
        1
      ],
      "existingTagUids": [
        1
      ]
    }
  ],
  "name": "text",
  "steps": [],
  "templateFields": null
}

200

Ok

No content

Custom Fields

get

Retrieves the list of paginated custom fields for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/customFields HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new custom field within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The custom field data to be created.

namestringRequired

The name of the custom field. A string representing the title or label of the custom field.

typestring · enumOptional

The type of the custom field. Optional field to specify the data type of the custom field (e.g., text, number, date). Defaults to undefined if not provided.

Possible values:

sourcestringOptional

The source of the custom field. Optional field to specify the origin or source of the custom field (e.g., "manual", "imported").

optionsstring[]Optional

The options for the custom field. Optional field to define the available choices for the custom field, applicable for certain types like dropdowns or radio buttons. Should be an array of strings representing the options.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/customFields HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "type": "text",
  "source": "text",
  "options": [
    "text"
  ]
}

200

The newly created custom field object.

No content

patch

Path parameters

handlestringRequired

keystringRequired

idnumber · doubleRequired

Body

Data Transfer Object for updating an existing custom field.

namestringOptional

The name of the custom field. Optional field to update the title or label of the custom field.

typestring · enumOptional

The type of the custom field. Optional field to update the data type of the custom field (e.g., text, number, date).

Possible values:

sourcestringOptional

The source of the custom field. Optional field to update the source or origin of the custom field.

optionsstring[]Optional

The options for the custom field. Optional field to update or add new options for the custom field. Should be an array of strings representing the updated options.

Responses

Responseany

patch

HTTPcURLJavaScriptPython

PATCH /v1/{handle}/projects/{key}/customFields/{id} HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "type": "text",
  "source": "text",
  "options": [
    "text"
  ]
}

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/customFields/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "success": true
}

Test Cases

get

Retrieves the list of paginated cases for a particular project of a user or organization.

Path parameters

handlestringRequired

The unique identifier for user or an organization.

keystringRequired

The unique identifier for a project.

Query parameters

limitnumber · doubleRequired

offsetnumber · doubleRequired

qstringOptional

prioritystringOptional

tagstringOptional

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/cases HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

post

Creates a new test case within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

Body

The test case data to be created.

customFieldsanyRequired

Custom fields associated with the case. This is an object that contains custom fields relevant to the case. The structure can vary depending on the specific custom fields for the case.

sourcestringRequired

The source from which the case originates. A string that represents the origin or the system from which the case is being created.

namestringRequired

The name of the case. A string that provides the title or label for the case.

prioritynumber · doubleOptional

The priority of the case. Optional field to define the importance or urgency of the case. It can be represented numerically (e.g., 1 = high priority).

repoUIDstringRequired

The repository UID where the case is located. A string that uniquely identifies the repository to which the case belongs.

parentIdnumber · doubleRequired

The parent case ID. A number that represents the ID of the parent case, allowing the case to be part of a hierarchy or grouping.

externalIdstringRequired

The external ID of the case. A string that represents an external identifier, often used to correlate or link the case with external systems or databases.

projectIdstringRequired

The project ID to which the case belongs. A string that identifies the project that the case is part of.

templateIdstringOptional

The template ID associated with the case. Optional field to specify a template to be applied to the case. It links the case to a predefined template for consistency in its structure.

tagIdsnumber · double[]Optional

The tag IDs associated with the case. Optional field that includes an array of tag IDs to categorize or label the case for better filtering or grouping.

Responses

Responseany

post

HTTPcURLJavaScriptPython

POST /v1/{handle}/projects/{key}/cases HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "customFields": null,
  "source": "text",
  "name": "text",
  "priority": 1,
  "repoUID": "text",
  "parentId": 1,
  "steps": [],
  "externalId": "text",
  "projectId": "text",
  "templateId": "text",
  "tagIds": [
    1
  ]
}

200

The newly created test case object.

No content

get

Retrieves the details of a specific test case within a project for a user or organization.

Path parameters

handlestringRequired

The unique identifier for a user or an organization.

keystringRequired

The unique identifier for a project.

idstringRequired

The unique identifier for the test case.

Responses

Responseany

get

HTTPcURLJavaScriptPython

GET /v1/{handle}/projects/{key}/cases/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

No content

delete

Path parameters

handlestringRequired

keystringRequired

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v1/{handle}/projects/{key}/cases/{id} HTTP/1.1
Host: api.testfiesta.com
Accept: */*

200

Ok

{
  "success": true
}