List environments for a project

Tag: Bug Environments

Create bug folder

Tag: Bug Folders

Delete bug folder

Tag: Bug Folders

Get bug folder by ID

Tag: Bug Folders

List bug folders

Tag: Bug Folders

Update bug folder

Tag: Bug Folders

List all bug priority levels

Tag: Bug Priorities

List all bug statuses

Tag: Bug Statuses

List bug types for a project

Tag: Bug Types

Create bug attachment (returns presigned upload URL)

Tag: Bug Attachments

Cria o registro do anexo (uploaded=false) e retorna uma presigned URL S3 (PUT, 300s). Faça o PUT do arquivo na uploadUrl e depois confirme com PATCH /v1/bugs/:id/attachments/:attachmentId.

Delete bug attachment

Tag: Bug Attachments

Remove o anexo (registro + arquivo no S3).

List bug attachments

Tag: Bug Attachments

Lista os anexos do bug. Itens com uploaded=true trazem downloadUrl (presigned, 300s).

Confirm bug attachment upload

Tag: Bug Attachments

Marca o anexo como enviado (uploaded=true) após o PUT no S3.

Create bug

Tag: Bugs

Delete bug

Tag: Bugs

Get bug by ID

Tag: Bugs

List bugs

Tag: Bugs

At least one query parameter is required: projectId or folderId.

Update bug

Tag: Bugs

Create cycle folder

Tag: Cycle Folders

Delete cycle folder

Tag: Cycle Folders

Get cycle folder by ID

Tag: Cycle Folders

List cycle folders

Tag: Cycle Folders

Update cycle folder

Tag: Cycle Folders

List all cycle statuses

Tag: Cycle Statuses

Create cycle

Tag: Cycles

Delete cycle

Tag: Cycles

Get cycle by ID

Tag: Cycles

List cycles

Tag: Cycles

At least one query parameter is required: projectId or folderId.

Update cycle

Tag: Cycles

Create execution attachment (returns presigned upload URL)

Tag: Execution Attachments

Cria o registro do anexo (uploaded=false) e retorna uma presigned URL S3 (PUT, 300s). Faça o PUT do arquivo na uploadUrl e depois confirme com PATCH /v1/executions/:id/attachments/:attachmentId.

Delete execution attachment

Tag: Execution Attachments

Remove o anexo (registro + arquivo no S3).

List execution attachments

Tag: Execution Attachments

Lista os anexos da execução. Itens com uploaded=true trazem downloadUrl (presigned, 300s).

Confirm execution attachment upload

Tag: Execution Attachments

Marca o anexo como enviado (uploaded=true) após o PUT no S3.

Create execution

Tag: Executions

The state field is system-managed and is silently ignored if sent in the body. Use /v1/executions-run, /v1/executions-pause and /v1/executions-finish to drive transitions.

Delete execution

Tag: Executions

Finish an execution

Tag: Executions

Sets the execution state to DONE and records executedAt and executedBy. Allowed only when the current state is IN_PROGRESS — returns 400 for WAITING, PAUSED or DONE, when its parent tests cycle is FINISHED, or when the execution's statusId is still "Em aberto" (NOT_EXECUTED) — a verdict must be set first.

Get execution by ID

Tag: Executions

List executions

Tag: Executions

Pause an execution

Tag: Executions

Sets the execution state to PAUSED. Allowed only when the current state is IN_PROGRESS — returns 400 for WAITING, PAUSED or DONE, or when its parent tests cycle is FINISHED.

Start running an execution

Tag: Executions

Sets the execution state to IN_PROGRESS. Allowed only when the current state is WAITING or PAUSED. Returns 400 when the execution is already IN_PROGRESS or DONE, or when its parent tests cycle is FINISHED.

Update execution

Tag: Executions

Executions in state: DONE are read-only and cannot be updated through this endpoint (public V1 only — the internal API does not enforce this guard). The state field itself is system-managed and is silently ignored if sent in the body — use /v1/executions-run, /v1/executions-pause and /v1/executions-finish instead.

Link one entity to multiple entities at once

Tag: Links

Creates one record per target. Operation is atomic — if any record fails, none are created. Paid-plan only: free-plan organizations receive 403.

Create a link between two entities

Tag: Links

Creates a directional link between two entities.

entityA is the entity currently open or being edited — its ID is stored in the corresponding foreign key field. entityB is the entity being linked to entityA — its type is stored in type and its ID in meloQaLinkedId.

Example use case: A user is editing a bug and opens the link panel to attach a test case. To replicate this action via the API, set entityAType to bug and entityAId to the ID of the open bug, then set entityBType to test-case and entityBId to the ID of the selected test case.

The same logic applies regardless of which entity type is open: always pass the entity being viewed as entityA and the entity being attached as entityB.

Paid-plan only: this endpoint requires the organization to have an active subscription. Free-plan organizations receive 403.

Remove a link

Tag: Links

Paid-plan only: free-plan organizations receive 403.

List links for an entity

Tag: Links

Returns all entities linked to the given entity, regardless of which side of the link it was created from.

Example use case: A user opens a bug and the UI needs to display its linked items panel. Pass entityType=bug and entityId as the ID of the open bug to retrieve all entities attached to it.

The response includes links where the given entity appears as either entityA (the entity that was open when the link was created) or entityB (the entity that was attached). Both directions are returned in a single call.

List all location countries

Tag: Location Countries

Get organization by ID

Tag: Organizations

List organizations

Tag: Organizations

List members of an organization

Tag: Organizations

Update organization

Tag: Organizations

The employeeQuantity field accepts one of the following values: 1 a 10, 11 a 50, 51 a 100, 100+. Send null to clear the value.

List available project pictures

Tag: Projects

List platforms for a project

Tag: Project Platforms

Create project

Tag: Projects

Validation rules:

• name must not exceed 20 characters.

• description must not exceed 250 characters.

• projectPictureUrl must reference a project picture predefined by the meloQA API — list the available IDs via GET /v1/project-pictures.

Delete project

Tag: Projects

List execution statuses available in a project

Tag: Projects

Returns the execution statuses that can be assigned to executions in this project. Includes both the system-wide defaults (projectId: null, isDefault: true) and any project-specific statuses created for it. Use the id of an entry as statusId when creating or updating an execution.

Get project by ID

Tag: Projects

List projects

Tag: Projects

Returns only projects the authenticated user has effective access to (i.e. is a project member of).

List members of a project

Tag: Projects

Returns the active (non-deleted) members of the project. The caller must be a member of the project.

List custom field definitions for test cases of a project

Tag: Projects

Returns the custom field schema configured for test cases in the project. Use the id of each entry as projectCustomFieldId when reading or writing test case custom field values.

Update project

Tag: Projects

Validation rules:

• name must not exceed 20 characters.

• description must not exceed 250 characters.

• projectPictureUrl must reference a project picture predefined by the meloQA API — list the available IDs via GET /v1/project-pictures.

Create tag

Tag: Tags

Delete tag

Tag: Tags

Get tag by ID

Tag: Tags

List tags

Tag: Tags

Update tag

Tag: Tags

Create test case folder

Tag: Test Case Folders

Folder hierarchy is limited to 3 sub-levels below the project root. Creating a folder under a parent that is already at the 3rd sub-level returns 400.

Delete test case folder

Tag: Test Case Folders

Removes the folder and hard-deletes every test case it contained, matching the meloQA front-end behavior. Child folders are removed in the same operation.

Get test case folder by ID

Tag: Test Case Folders

List test case folders

Tag: Test Case Folders

Update test case folder

Tag: Test Case Folders

When parentId is changed, the folder is moved together with its whole subtree. The resulting hierarchy must not exceed 3 sub-levels below the project root — otherwise the request is rejected with 400.

List all test case statuses

Tag: Test Case Statuses

List all test case types

Tag: Test Case Types

List archived test cases

Tag: Test Cases

Returns only archived test cases (statusId === ARCHIVED). At least one of projectId or folderId is required.

Create test case attachment (returns presigned upload URL)

Tag: Test Case Attachments

Cria o registro do anexo (uploaded=false) e retorna uma presigned URL S3 (PUT, 300s). Faça o PUT do arquivo na uploadUrl e depois confirme com PATCH /v1/test-cases/:id/attachments/:attachmentId.

Delete test case attachment

Tag: Test Case Attachments

Remove o anexo (registro + arquivo no S3).

List test case attachments

Tag: Test Case Attachments

Lista os anexos do test case. Itens com uploaded=true trazem downloadUrl (presigned, 300s).

Confirm test case attachment upload

Tag: Test Case Attachments

Marca o anexo como enviado (uploaded=true) após o PUT no S3.

Create test case

Tag: Test Cases

Delete test case

Tag: Test Cases

Get test case by ID

Tag: Test Cases

List test cases

Tag: Test Cases

At least one query parameter is required: projectId or folderId. Archived test cases (statusId === ARCHIVED) are excluded — use GET /v1/test-cases/archived to list those.

Unarchive test case

Tag: Test Cases

Restores an archived test case (statusId === ARCHIVED) into the folder specified by folderId. The status returns to whatever it was before archiving (statusBeforeId); when no previous status is recorded the test case falls back to FINISHED.

Update test case

Tag: Test Cases

Archived test cases (statusId === ARCHIVED) are read-only and cannot be updated through this endpoint.