TestRail API Shim

Projects

Returns the list of available projects.

get

Retrieves all projects related to the organization. This endpoint returns a paginated list of projects with details such as project ID, name, completion status, announcement, users, and groups.

Query parameters
limitintegerOptional

The number of projects to retrieve per page.

Default: 250
offsetintegerOptional

The offset for pagination.

Default: 0
is_completedintegerOptional

Filter projects by completion status. 1 to return completed projects only, 0 for active projects only.

Default: null
Responses
200

A list of projects for the specified organization with pagination.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 0,
  "limit": 250,
  "size": 1,
  "_links": {
    "next": null,
    "prev": null
  },
  "results": [
    {
      "id": 1,
      "completed_on": null,
      "default_role_id": null,
      "default_role": null,
      "is_completed": false,
      "name": "name",
      "show_announcement": false,
      "suite_mode": 1,
      "url": "url",
      "users": [
        "userUid"
      ],
      "groups": []
    }
  ]
}

Returns the details of a specific project.

get

Retrieves the details of a specific project based on its unique identifier.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
200

The details of the specified project.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "id": 1,
  "name": "text",
  "announcement": "text",
  "show_announcement": true,
  "suite_mode": 1,
  "url": "text",
  "users": [],
  "groups": []
}

Creates a new project.

post

Creates a new project with the provided details. This endpoint accepts a JSON object containing the necessary fields to create a project, such as the project name and an optional announcement.

Body
namestringRequired

The name of the project.

Example: Project Alpha
announcementstring | nullableOptional

The description or announcement of the project.

Example: This is a special announcement for Project Alpha.
Responses
200

The project was successfully created.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "name": "Project Alpha",
  "announcement": "This is a special announcement for Project Alpha."
}
{
  "id": 1,
  "name": "text",
  "announcement": "text",
  "show_announcement": true,
  "suite_mode": 1,
  "url": "text",
  "users": [],
  "groups": []
}

Updates an existing project.

post

Updates an existing project with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a project, such as the project name and an optional announcement.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the project.

announcementstringOptional

The description or announcement of the project.

Responses
200

The project was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "name": "text",
  "announcement": "text"
}
{
  "id": 1,
  "name": "text",
  "announcement": "text",
  "show_announcement": true,
  "suite_mode": 1,
  "url": "text",
  "users": [],
  "groups": []
}

Deletes a project.

post

Deletes a project with the provided details. This endpoint accepts a JSON object containing the necessary fields to delete a project, such as the project name and an optional announcement.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
200

The project was successfully deleted.

application/json
Responseany

The project was successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Test Suites & Sections (TestFiesta Folders)

Returns the details of a specific suite.

get

Retrieves the details of a specific suite based on its unique identifier.

Path parameters
suite_idintegerRequired

The unique identifier of the suite folderUid in TF.

Responses
200

The details of the specified suite.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "completed_on": 1,
  "description": "text",
  "id": 1,
  "is_baseline": true,
  "is_completed": true,
  "is_master": true,
  "name": "text",
  "project_id": 1,
  "url": "text"
}

Returns the list of suites for a specific project with pagination.

get

Retrieves the list of suites for a specific project based on its unique identifier with pagination.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
200

The list of suites for the specified project.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 1,
  "limit": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "suites": [
    {
      "completed_on": 1,
      "description": "text",
      "id": 1,
      "is_baseline": true,
      "is_completed": true,
      "is_master": true,
      "name": "text",
      "project_id": 1,
      "url": "text"
    }
  ]
}

Creates a new suite.

post

Creates a new suite with the provided details. This endpoint accepts a JSON object containing the necessary fields to create a suite, such as the suite name and an optional description.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
403

This operation is not permitted because this project only supports a single test suite.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
403

This operation is not permitted because this project only supports a single test suite.

No content

Updates an existing suite.

post

Updates an existing suite with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a suite, such as the suite name and an optional description.

Path parameters
suite_idintegerRequired

The unique identifier of the suite folderUid in TF.

Body
namestringOptional

The name of the suite.

descriptionstringOptional

The description of the suite.

Responses
200

The suite was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "completed_on": 1,
  "description": "text",
  "id": 1,
  "is_baseline": true,
  "is_completed": true,
  "is_master": true,
  "name": "text",
  "project_id": 1,
  "url": "text"
}

Deletes a suite.

post

Deletes a suite with the provided details. This endpoint accepts a JSON object containing the necessary fields to delete a suite, such as the suite name and an optional description.

Path parameters
suite_idintegerRequired

The unique identifier of the suite folderUid in TF.

Responses
403

This operation is not permitted because this project only supports a single test suite.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
403

This operation is not permitted because this project only supports a single test suite.

No content

Returns the details of a specific section.

get

Retrieves the details of a specific section based on its unique identifier.

Path parameters
section_idintegerRequired

The unique identifier of the section sectionUid in TF.

Responses
200

The details of the specified section.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "depth": 1,
  "description": "text",
  "display_order": 1,
  "id": 1,
  "name": "text",
  "parent_id": 1,
  "suite_id": 1
}

Returns the list of sections for a specific project.

get

Retrieves the list of sections for a specific project based on its unique identifier.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
200

The list of sections for the specified project.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 1,
  "limit": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "sections": [
    {
      "depth": 1,
      "description": "text",
      "display_order": 1,
      "id": 1,
      "name": "text",
      "parent_id": 1,
      "suite_id": 1
    }
  ]
}

Creates a new section.

post

Creates a new section with the provided details. This endpoint accepts a JSON object containing the necessary fields to create a section, such as the section name and an optional description.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the section.

descriptionstringOptional

The description of the section.

parent_idintegerOptional

The ID of the parent section in the test suite. If not provided, the section will be created under the root folder.

Responses
200

The section was successfully created.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "description": "text",
  "parent_id": 1
}
{
  "depth": 1,
  "description": "text",
  "display_order": 1,
  "id": 1,
  "name": "text",
  "parent_id": 1,
  "suite_id": 1
}

Moves a section to a new parent section.

post

Moves a section to a new parent section. This endpoint accepts a JSON object containing the necessary fields to move a section, such as the new parent section ID.

Path parameters
section_idintegerRequired

The unique identifier of the sub folder folderUid in TF.

Body
parent_idintegerOptional

The ID of the parent section (it can be null if it should be moved to the root). Must be in the same project and suite. May not be a direct child of the section being moved.

Responses
200

The section was successfully moved.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "parent_id": 1
}
{
  "depth": 1,
  "description": "text",
  "display_order": 1,
  "id": 1,
  "name": "text",
  "parent_id": 1,
  "suite_id": 1
}

Updates an existing section.

post

Updates an existing section with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a section, such as the section name and an optional description.

Path parameters
section_idintegerRequired

The unique identifier of the sub folder folderUid in TF.

Body
namestringOptional

The name of the section.

descriptionstringOptional

The description of the section.

Responses
200

The section was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "depth": 1,
  "description": "text",
  "display_order": 1,
  "id": 1,
  "name": "text",
  "parent_id": 1,
  "suite_id": 1
}

Deletes a section.

post

Deletes a section with the provided details. This endpoint accepts a JSON object containing the necessary fields to delete a section, such as the section name and an optional description.

Path parameters
section_idintegerRequired

The unique identifier of the sub folder folderUid in TF.

Responses
200

The section was successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Test Cases

Returns the details of a specific case.

get

Retrieves the details of a specific case based on its unique identifier.

Path parameters
case_idintegerRequired

The unique identifier of the case caseUid in TF.

Responses
200

The details of the specified case. In addition to the properties below, the response will also include the custom fields of the case which can be accessed by forming name as custom_case_<field_name>.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "created_by": "text",
  "created_on": 1,
  "id": 1,
  "priority_id": 1,
  "section_id": 1,
  "suite_id": 1,
  "is_deleted": 1,
  "type_id": 1,
  "template_id": 1,
  "title": "text",
  "labels": [],
  "updated_by": "text",
  "updated_on": 1
}

Returns the list of cases for a specific project.

get

Retrieves the list of cases for a specific project based on its unique identifier.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Query parameters
created_afterintegerOptional

Only return test cases created after this date (as UNIX timestamp)

created_beforeintegerOptional

Only return test cases created before this date (as UNIX timestamp)

created_bystringOptional

A comma-separated list of creators (user UIDs) to filter by

filterstringOptional

Only return cases with matching filter string in the case title

limitintegerOptional

The number of test cases the response should return

offsetintegerOptional

Where to start counting the tests cases from (the offset)

priority_idstringOptional

A comma-separated list of priority UIDs to filter by

section_idintegerOptional

The ID of a test case section

template_idstringOptional

A comma-separated list of template UIDs to filter by

type_idstringOptional

A comma-separated list of testCase tags to filter by

updated_afterintegerOptional

Only return test cases updated after this date (as UNIX timestamp)

updated_beforeintegerOptional

Only return test cases updated before this date (as UNIX timestamp)

Responses
200

The list of cases for the specified project.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 1,
  "limit": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "cases": [
    {
      "created_by": "text",
      "created_on": 1,
      "id": 1,
      "priority_id": 1,
      "section_id": 1,
      "suite_id": 1,
      "template_id": 1,
      "type_id": 1,
      "is_deleted": 1,
      "title": "text",
      "labels": [],
      "updated_by": "text",
      "updated_on": 1
    }
  ]
}

TestFiesta does not support this endpoint.

get

TestFiesta does not support this endpoint.

Responses
403

This operation is not permitted because TestFiesta does not support this endpoint.

get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
403

This operation is not permitted because TestFiesta does not support this endpoint.

No content

Creates a new case.

post

Creates a new case with the provided details. This endpoint accepts a JSON object containing the necessary fields to create a case, such as the case name and an optional description. In

Path parameters
section_idintegerRequired

The unique identifier of the section sectionUid in TF.

Body
titlestringOptional

The title / name of the test case

template_idintegerOptional

The ID of the template (field layout) if not provided, the default template will be used.

type_idintegerOptional

The ID of the testCase tag that is required to be linked to the test case

priority_idintegerOptional

The ID of the priority that is linked to the test case

labelsarrayOptional

The labels/tags of the test case can contain both tag UIDs and tag names.

Responses
200

The case was successfully created.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "title": "text",
  "template_id": 1,
  "type_id": 1,
  "priority_id": 1,
  "labels": []
}
{
  "created_by": "text",
  "created_on": 1,
  "id": 1,
  "priority_id": 1,
  "section_id": 1,
  "suite_id": 1,
  "template_id": 1,
  "type_id": 1,
  "is_deleted": 1,
  "title": "text",
  "labels": [],
  "updated_by": "text",
  "updated_on": 1
}

Copies cases to a section.

post

Copies cases to a section. This endpoint accepts a JSON object containing the necessary fields to copy cases to a section, such as the section ID and the cases to copy.

Path parameters
section_idintegerRequired

The unique identifier of the section sectionUid in TF.

Body
case_idsarrayOptional

A comma-separated list of case IDs to copy.

Responses
200

The cases were successfully copied.

application/json
Responseany

The cases were successfully copied.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "case_ids": []
}
No content

Updates an existing case.

post

Updates an existing case with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a case, such as the case name and an optional description.

Path parameters
case_idintegerRequired

The unique identifier of the case caseUid in TF.

Body
section_idintegerOptional

The ID of the section the test case should be moved to

titlestringOptional

The title / name of the test case

template_idintegerOptional

The ID of the template (field layout),

type_idintegerOptional

The ID of the testCase tag. Previous tags will be preserve and new tags will be added.

labelsarrayOptional

The labels/tags of the test case can contain both tag UIDs and tag names.

priority_idintegerOptional

The ID of the priority that is linked to the test case

Responses
200

The case was successfully updated. In addition to the properties below, the response will also include the custom fields of the case which can be accessed by forming name as custom_case_<field_name>.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "section_id": 1,
  "title": "text",
  "template_id": 1,
  "type_id": 1,
  "labels": [],
  "priority_id": 1
}
{
  "created_by": "text",
  "created_on": 1,
  "id": 1,
  "priority_id": 1,
  "section_id": 1,
  "suite_id": 1,
  "template_id": 1,
  "type_id": 1,
  "is_deleted": 1,
  "title": "text",
  "labels": [],
  "updated_by": "text",
  "updated_on": 1
}

Updates multiple cases.

post

Updates multiple cases with the provided details. This endpoint accepts a JSON object containing the necessary fields to update multiple cases, such as the case name and an optional description.

Path parameters
suite_idintegerRequired

The unique identifier of the suite suiteUid in TF.

Body
case_idsarrayOptional

A comma-separated list of case IDs that should be updated.

section_idintegerOptional

The ID of the section the test case should be moved to.

titlestringOptional

The title / name of the test case.

template_idintegerOptional

The ID of the template (field layout),

type_idintegerOptional

The ID of the testCase tag. Previous tags will be preserve and new tags will be added.

labelsarrayOptional

The labels/tags of the test case can contain both tag UIDs and tag names.

priority_idintegerOptional

The ID of the priority that is linked to the test case

Responses
200

The cases were successfully updated. In addition to the properties below, the response will also include the custom fields of the case which can be accessed by forming name as custom_case_<field_name>.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "case_ids": [],
  "section_id": 1,
  "title": "text",
  "template_id": 1,
  "type_id": 1,
  "labels": [],
  "priority_id": 1
}
[
  {
    "created_by": "text",
    "created_on": 1,
    "id": 1,
    "priority_id": 1,
    "section_id": 1,
    "suite_id": 1,
    "template_id": 1,
    "type_id": 1,
    "is_deleted": 1,
    "title": "text",
    "labels": [],
    "updated_by": "text",
    "updated_on": 1
  }
]

Moves cases to a section.

post

Moves cases to a section. This endpoint accepts a JSON object containing the necessary fields to move cases to a section, such as the section ID and the cases to move.

Path parameters
section_idintegerRequired

The unique identifier of the folder folderUid in TF in which the cases should be moved.

Body
case_idsarrayOptional

A comma-separated list of case IDs to move.

Responses
200

The cases were successfully moved.

application/json
Responseany

The cases were successfully moved.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "case_ids": []
}
No content

Deletes a case.

post

Deletes a case. This endpoint accepts a JSON object containing the necessary fields to delete a case, such as the case ID.

Path parameters
case_idintegerRequired

The unique identifier of the case caseUid in TF.

Body
softintegerOptional

soft=1 will return information about the data which will be deleted but will not proceed with the deletion

Responses
200

The cases were successfully deleted.

application/json
Responseany

The cases were successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "soft": 1
}
No content

Deletes multiple cases.

post

Deletes multiple cases with the provided details. This endpoint accepts a JSON object containing the necessary fields to delete multiple cases, such as the case IDs.

Path parameters
suite_idintegerRequired

The unique identifier of the suite suiteUid in TF.

Body
case_idsarrayOptional

A comma-separated list of case IDs to delete.

softintegerOptional

soft=1 will return information about the data which will be deleted but will not proceed with the deletion

Responses
200

The cases were successfully deleted.

application/json
Responseany

The cases were successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "case_ids": [],
  "soft": 1
}
No content

Test Runs

Retrieves a run.

get

Retrieves a run with the provided details. This endpoint accepts a JSON object containing the necessary fields to retrieve a run, such as the run ID.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Responses
200

The run was successfully retrieved. In addition to the properties below, the response will also include the count of statuses in the run which can be accessed by forming name as custom_<status_name>_count.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "assignedto_id": 1,
  "completed_on": 1,
  "config": "text",
  "config_ids": [],
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "id": 1,
  "include_all": true,
  "is_completed": true,
  "milestone_id": 1,
  "plan_id": 1,
  "name": "text",
  "project_id": 1,
  "suite_id": 1,
  "updated_on": 1,
  "url": "text",
  "refs": "text",
  "due_on": 1,
  "start_on": 1
}

Retrieves all runs for a project.

get

Retrieves all runs for a project. This endpoint accepts a JSON object containing the necessary fields to retrieve all runs for a project, such as the project ID.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Query parameters
created_afterintegerOptional

Only return test runs created after this date (as UNIX timestamp)

created_beforeintegerOptional

Only return test runs created before this date (as UNIX timestamp)

created_bystringOptional

A comma-separated list of creators (user IDs) to filter by

is_completedintegerOptional

1 to return completed / archived test runs only. 0 to return active test runs only

limitintegerOptional

Limit the result to limit test runs. Use offset to skip records

offsetintegerOptional

Use offset to skip records

milestone_idstringOptional

A comma-separated list of milestone IDs to filter by

Responses
200

The runs were successfully retrieved. In addition to the properties below, the response will also include the count of statuses in the run which can be accessed by forming name as custom_<status_name>_count.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 1,
  "limit": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "runs": [
    {
      "assignedto_id": 1,
      "completed_on": 1,
      "config": "text",
      "config_ids": [],
      "created_by": "text",
      "created_on": 1,
      "description": "text",
      "id": 1,
      "include_all": true,
      "is_completed": true,
      "milestone_id": 1,
      "plan_id": 1,
      "name": "text",
      "project_id": 1,
      "suite_id": 1,
      "updated_on": 1,
      "url": "text",
      "refs": "text",
      "due_on": 1,
      "start_on": 1
    }
  ]
}

Creates a new run.

post

Creates a new run with the provided details. This endpoint accepts a JSON object containing the necessary fields to create a run, such as the project ID.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the test run

descriptionstringOptional

The description of the test run

include_allbooleanOptional

True if the test run includes all test cases and false otherwise true by default

case_idsarrayOptional

A comma-separated list of case IDs to add to the test run. Required if include_all is false.

milestone_idintegerOptional

The ID of the milestone to link to the test run

due_onintegerOptional

The date/time when the test run is due (as UNIX timestamp)

assignedto_idstringOptional

The ID of the user to assign each execution that is added to the test run

Responses
200

The run was successfully created. In addition to the properties below, the response will also include the count of statuses in the run which can be accessed by forming name as custom_<status_name>_count.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "name": "text",
  "description": "text",
  "include_all": true,
  "case_ids": [],
  "milestone_id": 1,
  "due_on": 1,
  "assignedto_id": "text"
}
{
  "assignedto_id": 1,
  "completed_on": 1,
  "config": "text",
  "config_ids": [],
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "id": 1,
  "include_all": true,
  "is_completed": true,
  "milestone_id": 1,
  "plan_id": 1,
  "name": "text",
  "project_id": 1,
  "suite_id": 1,
  "updated_on": 1,
  "url": "text",
  "refs": "text",
  "due_on": 1,
  "start_on": 1
}

Updates an existing run.

post

Updates an existing run with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a run, such as the run ID.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Body
namestringOptional

The name of the test run

descriptionstringOptional

The description of the test run

include_allbooleanOptional

True if the test run includes all test cases and false otherwise true by default

case_idsarrayOptional

A comma-separated list of case IDs to add to the test run. Required if include_all is false.

milestone_idintegerOptional

This will add the milestone to the test run and will not remove any existing milestones.

due_onintegerOptional

The date/time when the test run is due (as UNIX timestamp)

Responses
200

The run was successfully created. In addition to the properties below, the response will also include the count of statuses in the run which can be accessed by forming name as custom_<status_name>_count.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "text",
  "description": "text",
  "include_all": true,
  "case_ids": [],
  "milestone_id": 1,
  "due_on": 1
}
{
  "assignedto_id": 1,
  "completed_on": 1,
  "config": "text",
  "config_ids": [],
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "id": 1,
  "include_all": true,
  "is_completed": true,
  "milestone_id": 1,
  "plan_id": 1,
  "name": "text",
  "project_id": 1,
  "suite_id": 1,
  "updated_on": 1,
  "url": "text",
  "refs": "text",
  "due_on": 1,
  "start_on": 1
}

Closes an existing run.

post

Closes an existing run with the provided details. This endpoint accepts a JSON object containing the necessary fields to close a run, such as the run ID.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Responses
200

The run was successfully closed. In addition to the properties below, the response will also include the count of statuses in the run which can be accessed by forming name as custom_<status_name>_count.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "assignedto_id": 1,
  "completed_on": 1,
  "config": "text",
  "config_ids": [],
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "id": 1,
  "include_all": true,
  "is_completed": true,
  "milestone_id": 1,
  "plan_id": 1,
  "name": "text",
  "project_id": 1,
  "suite_id": 1,
  "updated_on": 1,
  "url": "text",
  "refs": "text"
}

Deletes an existing run.

post

Deletes an existing run with the provided details. This endpoint accepts a JSON object containing the necessary fields to delete a run, such as the run ID.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Body
softintegerOptional

If soft=1, this will return data on the number of affected tests. Including soft=1 will not actually delete the entity.

Responses
200

The run was successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "soft": 1
}
No content

Test Plans

Retrieves a plan.

get

Retrieves a plan with the provided details. This endpoint accepts a JSON object containing the necessary fields to retrieve a plan, such as the plan ID.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

Responses
200

The plan was successfully retrieved. In addition to the properties below, the response will also include the count of statuses in the plan which can be accessed by forming name as custom_<status_name>_count.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "assignedto_id": 1,
  "completed_on": 1,
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "entries": [],
  "id": 1,
  "is_completed": true,
  "milestone_id": 1,
  "name": "text",
  "project_id": 1,
  "url": "text"
}

Retrieves all plans.

get

Retrieves all plans with the provided details. This endpoint accepts a JSON object containing the necessary fields to retrieve all plans, such as the project ID.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Query parameters
created_afterintegerOptional

Only return test plans created after this date (as UNIX timestamp)

created_beforeintegerOptional

Only return test plans created before this date (as UNIX timestamp)

created_bystringOptional

A comma-separated list of creators (user IDs) to filter by

is_completedintegerOptional

1 to return completed test plans only. 0 to return active test plans only

limitintegerOptional

Limit the result to limit test plans. Use offset to skip records

offsetintegerOptional

Use offset to skip records

milestone_idstringOptional

A comma-separated list of milestone IDs to filter by

Responses
200

The plans were successfully retrieved. In addition to the properties below, the response will also include the count of statuses in the plan which can be accessed by forming name as custom_<status_name>_count.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "offset": 1,
  "limit": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "plans": [
    {
      "assignedto_id": 1,
      "completed_on": 1,
      "created_by": "text",
      "created_on": 1,
      "description": "text",
      "id": 1,
      "is_completed": true,
      "milestone_id": 1,
      "name": "text",
      "project_id": 1,
      "refs": "text",
      "url": "text"
    }
  ]
}

Adds a plan.

post

Adds a plan with the provided details. This endpoint accepts a JSON object containing the necessary fields to add a plan, such as the project ID.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the test plan

descriptionstringOptional

The description of the test plan

milestone_idintegerOptional

The ID of the milestone to link to the test plan

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "name": "text",
  "description": "text",
  "milestone_id": 1,
  "entries": [
    {
      "include_all": true,
      "config_ids": [],
      "assignedto_id": "text",
      "runs": [
        {
          "include_all": true,
          "case_ids": [],
          "config_ids": [],
          "assignedto_id": "text"
        }
      ]
    }
  ]
}

Updates a plan.

post

Updates a plan with the provided details. This endpoint accepts a JSON object containing the necessary fields to update a plan, such as the plan ID.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

Body
namestringOptional

The name of the test plan

descriptionstringOptional

The description of the test plan

milestone_idintegerOptional

The ID of the milestone to link to the test plan

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "text",
  "description": "text",
  "milestone_id": 1
}

Adds a plan entry.

post

Testfairy does not support plan entries. This endpoint will add runs to the plan and runs will be grouped into 2 entries. 1 entry of the runs with configs and 1 entry of the runs without configs. In addtion to it there is no support for additional enteries the endpoint will add runs accordingly.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

Body
namestringOptional

The name of the test run(s)

descriptionstringOptional

The description of the test plan

case_idsarrayOptional

An array of case IDs for the custom case selection (Required if include_all is false)

assignedto_idstringOptional

The ID of the user to assign each execution that is added to the test run

config_idsarrayOptional

An array of configuration IDs used for the test run of the test plan entry

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "name": "text",
  "description": "text",
  "case_ids": [],
  "assignedto_id": "text",
  "config_ids": [],
  "runs": [
    {
      "include_all": true,
      "case_ids": [],
      "config_ids": [],
      "assignedto_id": "text"
    }
  ]
}

Adds a run to a plan entry.

post

Adds a run to a plan entry.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

entry_idstringRequired

The unique identifier of the plan entry entryUid in TF.

Body
config_idsarrayOptional

An array of configuration IDs used for the test run of the test plan entry

descriptionstringOptional

The description of the test run

include_allbooleanOptional

True for including all test cases of the test suite and false for a custom case selection

assignedto_idstringOptional

The ID of the user to assign each execution that is added to the test run

case_idsarrayOptional

An array of case IDs for the custom case selection

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "config_ids": [],
  "description": "text",
  "include_all": true,
  "assignedto_id": "text",
  "case_ids": []
}

Updates a plan entry.

post

Updates a plan entry.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

entry_idstringRequired

The unique identifier of the plan entry entryUid in TF.

Body
namestringOptional

The name of the test run(s)

descriptionstringOptional

The description of the test plan

case_idsarrayOptional

An array of case IDs for the custom case selection

include_allbooleanOptional

True for including all test cases of the test suite and false for a custom case selection

config_idsarrayOptional

An array of configuration IDs used for the test run of the test plan entry

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "name": "text",
  "description": "text",
  "case_ids": [],
  "include_all": true,
  "config_ids": []
}

Updates a run in a plan entry.

post

Updates a run in a plan entry.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Body
case_idsarrayOptional

An array of case IDs for the custom case selection

descriptionstringOptional

The description of the test run

include_allbooleanOptional

True for including all test cases of the test suite and false for a custom case selection

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "case_ids": [],
  "description": "text",
  "include_all": true
}

Closes a plan.

post

Closes a plan.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

Responses
200

The plan was successfully closed / archived.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "assignedto_id": 1,
  "completed_on": 1,
  "created_by": "text",
  "created_on": 1,
  "description": "text",
  "entries": [],
  "id": 1,
  "is_completed": true,
  "milestone_id": 1,
  "name": "text",
  "project_id": 1,
  "url": "text"
}

Deletes a plan.

post

Deletes a plan.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

Responses
200

The plan was successfully deleted.

application/json
Responseany
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Deletes a plan entry.

post

Deletes a plan entry.

Path parameters
plan_idintegerRequired

The unique identifier of the plan planUid in TF.

entry_idstringRequired

Id of entry in plan

Responses
200

The plan entry was successfully deleted.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Deletes a run from a plan entry.

post

Deletes a run from a plan entry.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Responses
200

The run was successfully deleted from the plan entry.

post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Milestones

Gets a milestone.

get

Gets a milestone.

Path parameters
milestone_idintegerRequired

The unique identifier of the milestone milestoneUid in TF.

Responses
200

The milestone was successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "completed_on": 1,
  "description": "text",
  "due_on": 1,
  "id": 1,
  "is_completed": true,
  "is_started": true,
  "milestones": [],
  "name": "text",
  "parent_id": 1,
  "project_id": 1,
  "refs": "text",
  "start_on": 1,
  "started_on": 1,
  "url": "text"
}

Gets milestones.

get

Gets milestones.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Responses
200

The milestones were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The milestones were successfully retrieved.

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "milestones": [
    {
      "completed_on": 1,
      "description": "text",
      "due_on": 1,
      "id": 1,
      "is_completed": true,
      "is_started": true,
      "milestones": [],
      "name": "text",
      "parent_id": 1,
      "project_id": 1,
      "refs": "text",
      "start_on": 1,
      "started_on": 1,
      "url": "text"
    }
  ]
}

Adds a milestone.

post

Adds a milestone.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the milestone

descriptionstringOptional

The description of the milestone

due_onintegerOptional

The due date of the milestone (as UNIX timestamp)

parent_idintegerOptional

The ID of the parent milestone, if any (for sub-milestones)

start_onintegerOptional

The scheduled start date of the milestone (as UNIX timestamp)

Responses
200

The milestone was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "name": "text",
  "description": "text",
  "due_on": 1,
  "parent_id": 1,
  "start_on": 1
}
{
  "completed_on": 1,
  "description": "text",
  "due_on": 1,
  "id": 1,
  "is_completed": true,
  "is_started": true,
  "milestones": [],
  "name": "text",
  "parent_id": 1,
  "project_id": 1,
  "refs": "text",
  "start_on": 1,
  "started_on": 1,
  "url": "text"
}

Updates a milestone.

post

Updates a milestone.

Path parameters
milestone_idintegerRequired

The unique identifier of the milestone milestoneUid in TF.

Body
is_completedbooleanOptional

True if a milestone is considered completed and false otherwise

is_startedbooleanOptional

True if a milestone is considered started and false otherwise

parent_idintegerOptional

The ID of the parent milestone, if any (for sub-milestones)

start_onintegerOptional

The scheduled start date of the milestone (as UNIX timestamp)

Responses
200

The milestone was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "is_completed": true,
  "is_started": true,
  "parent_id": 1,
  "start_on": 1
}
{
  "completed_on": 1,
  "description": "text",
  "due_on": 1,
  "id": 1,
  "is_completed": true,
  "is_started": true,
  "milestones": [],
  "name": "text",
  "parent_id": 1,
  "project_id": 1,
  "refs": "text",
  "start_on": 1,
  "started_on": 1,
  "url": "text"
}

Deletes a milestone.

post

Deletes a milestone.

Path parameters
milestone_idintegerRequired

The unique identifier of the milestone milestoneUid in TF.

Responses
200

The milestone was successfully deleted.

application/json
Responseany
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Tests (TestFiesta Test Executions)

Gets a test.

get

Gets a test.

Path parameters
test_idintegerRequired

The unique identifier of the test testUid in TF.

Responses
200

The test was successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "assigned_to_id": 1,
  "case_id": 1,
  "id": 1,
  "milestone_id": 1,
  "priority_id": 1,
  "refs": "text",
  "run_id": 1,
  "status_id": 1,
  "title": "text",
  "type_id": 1
}

Gets tests.

get

Gets tests.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Query parameters
status_idstringOptional

A comma-separated list of status IDs to filter by

limitintegerOptional

The number that sets the limit of tests to be shown on the response (Optional parameter. The response size limit is 250 by default) – requires TestRail 6.7 or later

offsetanyOptional

The number that sets the position where the response should start from (Optional parameter) – requires TestRail 6.7 or later

Responses
200

The tests were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "tests": [
    {
      "assigned_to_id": 1,
      "case_id": 1,
      "id": 1,
      "milestone_id": 1,
      "priority_id": 1,
      "refs": "text",
      "run_id": 1,
      "status_id": 1,
      "title": "text",
      "type_id": 1
    }
  ]
}

Test Results

Gets results.

get

Gets results.

Path parameters
test_idintegerRequired

The unique identifier of the test testUid in TF.

Query parameters
limitintegerOptional

The number that sets the limit of results to be shown on the response (Optional parameter. The response size limit is 250 by default) – requires TestRail 6.7 or later

offsetintegerOptional

The number that sets the position where the response should start from (Optional parameter) – requires TestRail 6.7 or later

Responses
200

The results were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The results were successfully retrieved.

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "results": [
    {
      "assignedto_id": 1,
      "comment": "text",
      "created_by": "text",
      "created_on": 1,
      "defects": "text",
      "id": 1,
      "status_id": 1,
      "test_id": 1
    }
  ]
}

Gets results for a case.

get

Gets results for a case.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

case_idintegerRequired

The unique identifier of the case caseUid in TF.

Query parameters
limitintegerOptional

The number that sets the limit of results to be shown on the response (Optional parameter. The response size limit is 250 by default) – requires TestRail 6.7 or later

offsetintegerOptional

The number that sets the position where the response should start from (Optional parameter) – requires TestRail 6.7 or later

Responses
200

The results were successfully retrieved.

get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

No content

Gets results for a run.

get

Gets results for a run.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Query parameters
limitintegerOptional

The number that sets the limit of results to be shown on the response (Optional parameter. The response size limit is 250 by default) – requires TestRail 6.7 or later

offsetintegerOptional

The number that sets the position where the response should start from (Optional parameter) – requires TestRail 6.7 or later

created_afterintegerOptional

Only return test results created after this date (as UNIX timestamp)

created_beforeintegerOptional

Only return test results created before this date (as UNIX timestamp)

created_bystringOptional

A comma-separated list of creators (user IDs) to filter by

status_idstringOptional

A comma-separated list of status IDs to filter by

Responses
200

The results were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "results": [
    {
      "assignedto_id": 1,
      "comment": "text",
      "created_by": "text",
      "created_on": 1,
      "defects": "text",
      "id": 1,
      "status_id": 1
    }
  ]
}

Adds a result.

post

Adds a result.

Path parameters
test_idintegerRequired

The unique identifier of the test testUid in TF.

Body
status_idintegerOptional

The ID of the test status.

commentstringOptional

The comment/description for the test result

Responses
200

The result was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "status_id": 1,
  "comment": "text"
}
{
  "assignedto_id": 1,
  "comment": "text",
  "created_by": "text",
  "created_on": 1,
  "defects": "text",
  "id": 1,
  "status_id": 1,
  "test_id": 1
}

Adds a result for a case.

post

Adds a result for a case.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

case_idintegerRequired

The unique identifier of the case caseUid in TF.

Body
status_idintegerOptional

The ID of the test status.

commentstringOptional

The comment/description for the test result

Responses
200

The result was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "status_id": 1,
  "comment": "text"
}
{
  "assignedto_id": 1,
  "comment": "text",
  "created_by": "text",
  "created_on": 1,
  "defects": "text",
  "id": 1,
  "status_id": 1,
  "test_id": 1
}

Adds results.

post

Adds results.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Body
Responses
200

The results were successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "results": [
    {
      "test_id": 1,
      "status_id": 1,
      "comment": "text"
    }
  ]
}
200

The results were successfully added.

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "results": [
    {}
  ],
  "properties": null
}

Adds results for cases.

post

Adds results for cases.

Path parameters
run_idintegerRequired

The unique identifier of the run runUid in TF.

Body
Responses
200

The results were successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "results": [
    {
      "case_id": 1,
      "status_id": 1,
      "comment": "text"
    }
  ]
}
200

The results were successfully added.

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "results": [
    {}
  ],
  "properties": null
}

Settings and Configurations

Gets case types.

get

Gets case types.

Responses
200

The case types were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The case types were successfully retrieved.

[
  {
    "id": 1,
    "name": "text",
    "is_default": true
  }
]

Gets priorities.

get

Gets priorities.

Responses
200

The priorities were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The priorities were successfully retrieved.

[
  {
    "id": 1,
    "name": "text",
    "is_default": true,
    "priority": 1,
    "short_name": "text"
  }
]

Gets statuses.

get

Gets statuses.

Responses
200

The statuses were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The statuses were successfully retrieved.

[
  {
    "color_bright": 1,
    "color_dark": 1,
    "color_medium": 1,
    "id": 1,
    "is_final": true,
    "is_system": true,
    "is_untested": true,
    "label": "text",
    "name": "text"
  }
]

Gets templates.

get

Gets templates.

Responses
200

The templates were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The templates were successfully retrieved.

[
  {
    "id": 1,
    "name": "text",
    "is_default": true,
    "case_fields": [
      {
        "system_name": "text",
        "name": "text",
        "type": "text"
      }
    ]
  }
]

Gets configurations.

get

Gets configurations.

Responses
200

The configurations were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The configurations were successfully retrieved.

[
  {
    "id": 1,
    "name": "text",
    "project_id": 1,
    "configs": [
      {
        "id": 1,
        "name": "text",
        "group_id": 1
      }
    ]
  }
]

Adds a configuration group.

post

Adds a configuration group.

Path parameters
project_idintegerRequired

The unique identifier of the project projectUid in TF.

Body
namestringOptional

The name of the configuration group

Responses
200

The configuration group was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

The configuration group was successfully added.

{
  "id": 1,
  "name": "text",
  "project_id": 1,
  "configs": [
    {
      "id": 1,
      "name": "text",
      "group_id": 1
    }
  ]
}

Adds a configuration.

post

Adds a configuration.

Path parameters
config_group_idintegerRequired

The unique identifier of the configuration group configGroupUid in TF.

Body
namestringOptional

The name of the configuration

Responses
200

The configuration was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

The configuration was successfully added.

{
  "id": 1,
  "name": "text",
  "group_id": 1
}

Updates a configuration group.

post

Updates a configuration group.

Path parameters
config_group_idintegerRequired

The unique identifier of the configuration group configGroupUid in TF.

Body
namestringOptional

The name of the configuration group

Responses
200

The configuration group was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

The configuration group was successfully updated.

{
  "id": 1,
  "name": "text",
  "project_id": 1,
  "configs": [
    {
      "id": 1,
      "name": "text",
      "group_id": 1
    }
  ]
}

Updates a configuration.

post

Updates a configurations.

Path parameters
config_idintegerRequired

The unique identifier of the configuration configUid in TF.

Body
namestringOptional

Name of the configuration to update

Responses
200

The configuration was successfully updated.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

The configuration was successfully updated.

{
  "id": 1,
  "name": "text",
  "project_id": 1,
  "configs": [
    {
      "id": 1,
      "name": "text",
      "group_id": 1
    }
  ]
}

Deletes a configuration group.

post

Deletes a configuration group.

Path parameters
config_group_idintegerRequired

The unique identifier of the configuration group configGroupUid in TF.

Responses
200

The configuration group was successfully deleted.

application/json
Responseany
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The configuration group was successfully deleted.

No content

Deletes a configuration.

post

Deletes a configuration.

Path parameters
config_idintegerRequired

The unique identifier of the configuration configUid in TF.

Responses
200

The configuration was successfully deleted.

application/json
Responseany
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The configuration was successfully deleted.

No content

Attachments

Adds an attachment to a case.

post

Adds an attachment to a case.

Path parameters
case_idintegerRequired

The unique identifier of the case caseUid in TF.

Body
attachmentstringOptional

The attachment to add

Responses
200

The attachment was successfully added.

application/json
post
POST /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 21

{
  "attachment": "text"
}
200

The attachment was successfully added.

{
  "attachment_id": "text"
}

Gets attachments for a case.

get

Gets attachments for a case.

Path parameters
case_idintegerRequired

The unique identifier of the case caseUid in TF.

Responses
200

The attachments were successfully retrieved.

application/json
get
GET /trv2/{org-handle}/index.php HTTP/1.1
Host: api.testfiesta.com
Accept: */*
200

The attachments were successfully retrieved.

{
  "limit": 1,
  "offset": 1,
  "size": 1,
  "_links": {
    "next": "text",
    "prev": "text"
  },
  "attachments": [
    {
      "id": 1,
      "name": "text",
      "size": 1,
      "created_on": 1,
      "project_id": 1,
      "case_id": 1,
      "user_id": 1
    }
  ]
}
PreviousCore API Endpoints

Last updated