Executions

This is where automated results land. An execution records the outcome of one test case inside one cycle, and step executions record the per-step detail underneath it. The server stamps the test case version and the run times; you send the result.

List test case executions

GET/api/v1/test_case_executions

Lists test case execution resources as a JSON:API collection document. Narrow the set with filter, order it with sort, embed related resources with include, select attributes with fields[<type>], and page with page[size] plus page[number] (offset) or page[after] (cursor, taken from the previous response's links.next).

Query parameters

filterstring: A FiltrQL expression, url-encoded. Combine conditions with AND / OR and parentheses. The fields you can filter on, and the operators each accepts, are listed under Filterable fields.; testCaseExecutionKey = "A-EXEC-1"
sortstring: Comma-separated sort fields; prefix a field with "-" for descending order (e.g. "-createdAt,title"). Permitted fields: id, organizationId, projectId, testCaseExecutionKey, preTestCaseExecutionId, result, testCycleId, testCaseId, environmentId, assigneeId, sourceCollectionId, sourceType, startedAt, executedAt, createdAt, sourceRequirementId.; -testCaseExecutionKey
includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: assigneeUser, testCollection, createdByUser, testCycle, environment, organization, testCaseExecution, project, requirement, testCase, updatedByUser, version.; assigneeUser
fields[test_case_executions]string[]: Sparse fieldset for resource type "test_case_executions" - comma-separated subset of its exposed fields: id, organizationId, projectId, testCaseExecutionKey, preTestCaseExecutionId, result, testCycleId, testCaseId, testCaseVersion, comments, environmentId, assigneeId, versionId, sourceCollectionId, sourceType, sourceContext, startedAt, executedAt, actualExecutionTime, createdAt, updatedAt, createdBy, updatedBy, sourceRequirementId, resultSetByHand, isFinished, assigneeUser, createdByUser, updatedByUser, testCollection, testCycle, environment, organization, testCaseExecution, project, requirement, testCase, version.; testCaseExecutionKey,result,testCaseVersion
page[size]integer: Number of resources per page (applies to both offset and cursor pagination). Minimum 1, maximum 100, default 25 when omitted.; 25
page[number]integer: 1-indexed page number for offset-based pagination. Mutually exclusive with "page[after]" - supplying both is rejected with a 400 (CONFLICTING_PAGINATION).; 2
page[after]string: Opaque cursor for cursor-based pagination - always taken verbatim from a previous response's "links.next" value, never client-constructed or decoded. Mutually exclusive with "page[number]" - supplying both is rejected with a 400 (CONFLICTING_PAGINATION).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Filterable fields26

Show fields and operators

Field	Type	Operators
`id`	uuid	= != in (…) not in (…) is null is not null
`organizationId`	uuid	= != in (…) not in (…) is null is not null
`projectId`	uuid	= != in (…) not in (…) is null is not null
`testCaseExecutionKey`	string	= != in (…) not in (…) ~ is null is not null
`preTestCaseExecutionId`	uuid	= != in (…) not in (…) is null is not null
`result`	enum	= != in (…) not in (…) is null is not nullNOT_EXECUTED, IN_PROGRESS, PASSED, FAILED, BLOCKED, SKIPPED
`testCycleId`	uuid	= != in (…) not in (…) is null is not null
`testCaseId`	uuid	= != in (…) not in (…) is null is not null
`testCaseVersion`	int	= != < <= > >= in (…) not in (…) is null is not null
`comments`	string	~ is null is not null is empty is not empty
`environmentId`	uuid	= != in (…) not in (…) is null is not null
`assigneeId`	uuid	= != in (…) not in (…) is null is not null
`versionId`	uuid	= != in (…) not in (…) is null is not null
`sourceCollectionId`	uuid	= != in (…) not in (…) is null is not null
`sourceType`	enum	= != in (…) not in (…) is null is not nullMANUAL_SELECTION, COLLECTION_MANUAL, COLLECTION_RULE, FOLDER, BULK_IMPORT, REQUIREMENT_COVERAGE, COLLECTION_REQUIREMENT_COVERAGE
`sourceContext`	string	~ is null is not null is empty is not empty
`startedAt`	datetime	= != < <= > >= is null is not null
`executedAt`	datetime	= != < <= > >= is null is not null
`actualExecutionTime`	int	= != < <= > >= in (…) not in (…) is null is not null
`createdAt`	datetime	= != < <= > >= is null is not null
`updatedAt`	datetime	= != < <= > >= is null is not null
`createdBy`	uuid	= != in (…) not in (…) is null is not null
`updatedBy`	uuid	= != in (…) not in (…) is null is not null
`sourceRequirementId`	uuid	= != in (…) not in (…) is null is not null
`resultSetByHand`	bool	= != is null is not null
`isFinished`	bool	= != is null is not null

Filter through a relation with ANY, ALL or NONE, for example assigneeUser ANY (id = "…"). Relations: assigneeUser, testCollection, createdByUser, testCycle, environment, organization, testCaseExecution, testCaseExecutions, project, requirement, testCase, updatedByUser, version, testStepExecutions.

Returns the same attributes as Get a test case execution.

Responses

200Success.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INVALID_TYPED_JSON_FILTERUNKNOWN_SORT_FIELDINCLUDE_DEPTH_EXCEEDEDUNKNOWN_RELATIONINCLUDE_RESOURCES_EXCEEDEDUNKNOWN_TYPEUNKNOWN_FIELDCONFLICTING_PAGINATIONINVALID_PAGE_SIZEPAGE_SIZE_EXCEEDEDINVALID_PAGE_NUMBERINPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions?page%5Bsize%5D=25" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_case_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "testCaseExecutionKey": "KAN-EXEC-311",
        "result": "PASSED",
        "comments": "Playwright run #1482, commit a1b2c3d",
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/test_case_executions?page[size]=25",
    "first": "/test_case_executions?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/test_case_executions?page[size]=25&page[number]=2",
    "last": "/test_case_executions?page[size]=25&page[number]=6"
  },
  "meta": {
    "totalCount": 128
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Create a test case execution

POST/api/v1/test_case_executions

Creates a test case execution from a JSON:API resource object - data.type names the resource type and data.attributes carries the writable attributes - and returns the created resource.

Needs a read-and-write token. A read-only token gets 403.

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Anything else returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send14

projectIduuidrequired
testCaseIduuidrequired
testCycleIduuidrequired
actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
environmentIduuid | null
preTestCaseExecutionIduuid | null

Show the remaining 6

resultstringdefault NOT_EXECUTED: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
versionIduuid | null

Returns the same attributes as Get a test case execution.

Responses

201Created.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.MISSING_CONTENT_TYPEINVALID_CONTENT_TYPEINVALID_CONTENT_TYPE_PARAMSPARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.INVALID_INPUTVALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

See it in a workflow

Create a cycle, add an execution for a case, record its result, review the cycle

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions" \
  -X POST \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_case_executions",
    "attributes": {
      "projectId": "03ff802c-4fcb-4718-8eb8-12ecc999f758",
      "testCaseId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testCycleId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "result": "PASSED"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_case_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "testCaseExecutionKey": "KAN-EXEC-311",
        "result": "PASSED",
        "comments": "Playwright run #1482, commit a1b2c3d",
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/test_case_executions?page[size]=25",
    "first": "/test_case_executions?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/test_case_executions?page[size]=25&page[number]=2",
    "last": "/test_case_executions?page[size]=25&page[number]=6"
  },
  "meta": {
    "totalCount": 128
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Count and aggregate test case executions

GET/api/v1/test_case_executions/aggregate

Aggregates test case execution resources - a count and per-column aggregations, optionally grouped - over the same filter the collection route accepts.

Query parameters

aggregations[count]boolean: Include the row count in the aggregate result. When no aggregation is requested at all, the runtime defaults to count.
aggregations[sum][]string[]: Column(s) to sum - repeat the bracketed key per column (aggregations[sum][]=a&aggregations[sum][]=b). Permitted columns: testCaseVersion, actualExecutionTime.
aggregations[avg][]string[]: Column(s) to average - repeat the bracketed key per column (aggregations[avg][]=a&aggregations[avg][]=b). Permitted columns: testCaseVersion, actualExecutionTime.
aggregations[min][]string[]: Column(s) to take the minimum of - repeat the bracketed key per column (aggregations[min][]=a&aggregations[min][]=b). Permitted columns: testCaseExecutionKey, testCaseVersion, comments, sourceContext, startedAt, executedAt, actualExecutionTime, createdAt, updatedAt.
aggregations[max][]string[]: Column(s) to take the maximum of - repeat the bracketed key per column (aggregations[max][]=a&aggregations[max][]=b). Permitted columns: testCaseExecutionKey, testCaseVersion, comments, sourceContext, startedAt, executedAt, actualExecutionTime, createdAt, updatedAt.
aggregations[groupBy][]string[]: Column(s) to group by - repeating the bracketed key switches the response to the grouped shape (aggregations[groupBy][]=a&aggregations[groupBy][]=b). Permitted columns: id, organizationId, projectId, testCaseExecutionKey, preTestCaseExecutionId, result, testCycleId, testCaseId, environmentId, assigneeId, sourceCollectionId, sourceType, startedAt, executedAt, createdAt, sourceRequirementId.
filterstring: A FiltrQL expression, url-encoded. Combine conditions with AND / OR and parentheses. The fields you can filter on, and the operators each accepts, are listed under Filterable fields.; testCaseExecutionKey = "A-EXEC-1"

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Filterable fields26

Show fields and operators

Field	Type	Operators
`id`	uuid	= != in (…) not in (…) is null is not null
`organizationId`	uuid	= != in (…) not in (…) is null is not null
`projectId`	uuid	= != in (…) not in (…) is null is not null
`testCaseExecutionKey`	string	= != in (…) not in (…) ~ is null is not null
`preTestCaseExecutionId`	uuid	= != in (…) not in (…) is null is not null
`result`	enum	= != in (…) not in (…) is null is not nullNOT_EXECUTED, IN_PROGRESS, PASSED, FAILED, BLOCKED, SKIPPED
`testCycleId`	uuid	= != in (…) not in (…) is null is not null
`testCaseId`	uuid	= != in (…) not in (…) is null is not null
`testCaseVersion`	int	= != < <= > >= in (…) not in (…) is null is not null
`comments`	string	~ is null is not null is empty is not empty
`environmentId`	uuid	= != in (…) not in (…) is null is not null
`assigneeId`	uuid	= != in (…) not in (…) is null is not null
`versionId`	uuid	= != in (…) not in (…) is null is not null
`sourceCollectionId`	uuid	= != in (…) not in (…) is null is not null
`sourceType`	enum	= != in (…) not in (…) is null is not nullMANUAL_SELECTION, COLLECTION_MANUAL, COLLECTION_RULE, FOLDER, BULK_IMPORT, REQUIREMENT_COVERAGE, COLLECTION_REQUIREMENT_COVERAGE
`sourceContext`	string	~ is null is not null is empty is not empty
`startedAt`	datetime	= != < <= > >= is null is not null
`executedAt`	datetime	= != < <= > >= is null is not null
`actualExecutionTime`	int	= != < <= > >= in (…) not in (…) is null is not null
`createdAt`	datetime	= != < <= > >= is null is not null
`updatedAt`	datetime	= != < <= > >= is null is not null
`createdBy`	uuid	= != in (…) not in (…) is null is not null
`updatedBy`	uuid	= != in (…) not in (…) is null is not null
`sourceRequirementId`	uuid	= != in (…) not in (…) is null is not null
`resultSetByHand`	bool	= != is null is not null
`isFinished`	bool	= != is null is not null

Responses

200Success.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

See it in a workflow

Count executions per result across the project

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions/aggregate?aggregations%5Bcount%5D=true&aggregations%5BgroupBy%5D%5B%5D=result" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "testCaseExecutions_aggregate",
    "id": "(aggregate)",
    "attributes": {
      "groups": [
        {
          "key": {
            "result": "PASSED"
          },
          "aggregate": {
            "count": 257
          }
        },
        {
          "key": {
            "result": "FAILED"
          },
          "aggregate": {
            "count": 12
          }
        },
        {
          "key": {
            "result": "NOT_EXECUTED"
          },
          "aggregate": {
            "count": 75
          }
        }
      ]
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Get a test case execution

GET/api/v1/test_case_executions/{id}

Returns the test case execution with this id as a JSON:API resource document; include embeds related resources and fields[<type>] selects the attributes returned.

Path parameters

iduuidrequired: The resource id (a UUID).

Query parameters

includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: assigneeUser, testCollection, createdByUser, testCycle, environment, organization, testCaseExecution, project, requirement, testCase, updatedByUser, version.; assigneeUser
fields[test_case_executions]string[]: Sparse fieldset for resource type "test_case_executions" - comma-separated subset of its exposed fields: id, organizationId, projectId, testCaseExecutionKey, preTestCaseExecutionId, result, testCycleId, testCaseId, testCaseVersion, comments, environmentId, assigneeId, versionId, sourceCollectionId, sourceType, sourceContext, startedAt, executedAt, actualExecutionTime, createdAt, updatedAt, createdBy, updatedBy, sourceRequirementId, resultSetByHand, isFinished, assigneeUser, createdByUser, updatedByUser, testCollection, testCycle, environment, organization, testCaseExecution, project, requirement, testCase, version.; testCaseExecutionKey,result,testCaseVersion

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned26

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-timeread-only
createdByuuid | nullread-only
environmentIduuid | null
executedAtdate-time | nullread-only
iduuidread-only

Show the remaining 18

isFinishedbooleanread-onlydefault false
organizationIduuidread-only
preTestCaseExecutionIduuid | nullread-only
projectIduuid
resultstringdefault NOT_EXECUTED: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
resultSetByHandbooleanread-onlydefault false
sourceCollectionIduuid | nullread-only
sourceContextstring | nullread-only
sourceRequirementIduuid | nullread-only
sourceTypestring | nullread-only: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | nullread-only
testCaseExecutionKeystringread-only
testCaseIduuidread-only
testCaseVersionintegerread-only
testCycleIduuidread-only
updatedAtdate-timeread-only
updatedByuuid | nullread-only
versionIduuid | null

Responses

200Success.

12 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.UNKNOWN_TYPEUNKNOWN_FIELDINCLUDE_DEPTH_EXCEEDEDUNKNOWN_RELATIONINCLUDE_RESOURCES_EXCEEDEDINPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
410Gone.GONE
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

See it in a workflow

Create a cycle, add an execution for a case, record its result, review the cycle

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "testCaseExecutionKey": "KAN-EXEC-311",
      "result": "PASSED",
      "comments": "Playwright run #1482, commit a1b2c3d",
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Update a test case execution

PATCH/api/v1/test_case_executions/{id}

Updates the test case execution with this id from a JSON:API resource object carrying only the attributes to change, and returns the updated resource. A resource that carries an ETag requires it back as If-Match.

Needs a read-and-write token. A read-only token gets 403.

Version-locked: send the ETag from your last read as If-Match.

Path parameters

iduuidrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Anything else returns 415 Unsupported Media Type.; application/vnd.api+json
If-Matchstringrequired: The ETag from your last read of this resource, sent back verbatim. Missing returns 428 Precondition Required; stale (someone changed it since you read it) returns 412 Precondition Failed. Read it again and retry.; W/"3"

Attributes you can send7

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
environmentIduuid | null
projectIduuid
resultstringdefault NOT_EXECUTED: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
versionIduuid | null

Returns the same attributes as Get a test case execution.

Responses

200Success.

13 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
412The If-Match ETag is stale: the resource changed since you read it. Read it again and retry.STALE_OBJECT
415The Content-Type was not application/vnd.api+json.MISSING_CONTENT_TYPEINVALID_CONTENT_TYPEINVALID_CONTENT_TYPE_PARAMSPARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_ERRORVALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
428This resource is version-locked: send its ETag in an If-Match header.MISSING_IF_MATCH
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

See it in a workflow

Create a cycle, add an execution for a case, record its result, review the cycle

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X PATCH \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H 'If-Match: W/"3"' \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "result": "PASSED"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "testCaseExecutionKey": "KAN-EXEC-311",
      "result": "PASSED",
      "comments": "Playwright run #1482, commit a1b2c3d",
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

List test step executions

GET/api/v1/test_step_executions

Lists test step execution resources as a JSON:API collection document. Narrow the set with filter, order it with sort, embed related resources with include, select attributes with fields[<type>], and page with page[size] plus page[number] (offset) or page[after] (cursor, taken from the previous response's links.next).

Query parameters

filterstring: A FiltrQL expression, url-encoded. Combine conditions with AND / OR and parentheses. The fields you can filter on, and the operators each accepts, are listed under Filterable fields.; result = "NOT_EXECUTED"
sortstring: Comma-separated sort fields; prefix a field with "-" for descending order (e.g. "-createdAt,title"). Permitted fields: id, organizationId, projectId, result, testCaseExecutionId, testStepId.
includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: testCaseExecution, createdByUser, organization, project, testStep, updatedByUser.; testCaseExecution
fields[test_step_executions]string[]: Sparse fieldset for resource type "test_step_executions" - comma-separated subset of its exposed fields: id, organizationId, projectId, result, testCaseExecutionId, testStepId, testStepVersion, actualResult, comments, snapshotSequenceNumber, snapshotAction, snapshotTestData, snapshotExpectedResult, snapshotBddContent, createdAt, updatedAt, createdBy, updatedBy, testCaseExecution, createdByUser, updatedByUser, organization, project, testStep.; result,testStepVersion,actualResult
page[size]integer: Number of resources per page (applies to both offset and cursor pagination). Minimum 1, maximum 100, default 25 when omitted.; 25
page[number]integer: 1-indexed page number for offset-based pagination. Mutually exclusive with "page[after]" - supplying both is rejected with a 400 (CONFLICTING_PAGINATION).; 2
page[after]string: Opaque cursor for cursor-based pagination - always taken verbatim from a previous response's "links.next" value, never client-constructed or decoded. Mutually exclusive with "page[number]" - supplying both is rejected with a 400 (CONFLICTING_PAGINATION).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Filterable fields18

Show fields and operators

Field	Type	Operators
`id`	uuid	= != in (…) not in (…) is null is not null
`organizationId`	uuid	= != in (…) not in (…) is null is not null
`projectId`	uuid	= != in (…) not in (…) is null is not null
`result`	enum	= != in (…) not in (…) is null is not nullNOT_EXECUTED, PASSED, FAILED, BLOCKED, SKIPPED
`testCaseExecutionId`	uuid	= != in (…) not in (…) is null is not null
`testStepId`	uuid	= != in (…) not in (…) is null is not null
`testStepVersion`	int	= != < <= > >= in (…) not in (…) is null is not null
`actualResult`	string	~ is null is not null is empty is not empty
`comments`	string	~ is null is not null is empty is not empty
`snapshotSequenceNumber`	int	= != < <= > >= in (…) not in (…) is null is not null
`snapshotAction`	string	~ is null is not null is empty is not empty
`snapshotTestData`	string	~ is null is not null is empty is not empty
`snapshotExpectedResult`	string	~ is null is not null is empty is not empty
`snapshotBddContent`	string	~ is null is not null is empty is not empty
`createdAt`	datetime	= != < <= > >= is null is not null
`updatedAt`	datetime	= != < <= > >= is null is not null
`createdBy`	uuid	= != in (…) not in (…) is null is not null
`updatedBy`	uuid	= != in (…) not in (…) is null is not null

Filter through a relation with ANY, ALL or NONE, for example testCaseExecution ANY (id = "…"). Relations: testCaseExecution, createdByUser, organization, project, testStep, updatedByUser.

Returns the same attributes as Get a test step execution.

Responses

200Success.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INVALID_TYPED_JSON_FILTERUNKNOWN_SORT_FIELDINCLUDE_DEPTH_EXCEEDEDUNKNOWN_RELATIONINCLUDE_RESOURCES_EXCEEDEDUNKNOWN_TYPEUNKNOWN_FIELDCONFLICTING_PAGINATIONINVALID_PAGE_SIZEPAGE_SIZE_EXCEEDEDINVALID_PAGE_NUMBERINPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions?page%5Bsize%5D=25" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_step_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "result": "PASSED",
        "comments": "Playwright run #1482, commit a1b2c3d",
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/test_step_executions?page[size]=25",
    "first": "/test_step_executions?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/test_step_executions?page[size]=25&page[number]=2",
    "last": "/test_step_executions?page[size]=25&page[number]=6"
  },
  "meta": {
    "totalCount": 128
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Create a test step execution

POST/api/v1/test_step_executions

Creates a test step execution from a JSON:API resource object - data.type names the resource type and data.attributes carries the writable attributes - and returns the created resource.

Needs a read-and-write token. A read-only token gets 403.

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Anything else returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send11

projectIduuidrequired
testCaseExecutionIduuidrequired
testStepIduuidrequired
actualResultstring | null
commentsstring | null
resultstringdefault NOT_EXECUTED: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED
snapshotActionstring | null
snapshotBddContentstring | null

Show the remaining 3

snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null

Returns the same attributes as Get a test step execution.

Responses

201Created.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.MISSING_CONTENT_TYPEINVALID_CONTENT_TYPEINVALID_CONTENT_TYPE_PARAMSPARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.INVALID_INPUTVALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions" \
  -X POST \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_step_executions",
    "attributes": {
      "projectId": "03ff802c-4fcb-4718-8eb8-12ecc999f758",
      "testCaseExecutionId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testStepId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "result": "PASSED"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_step_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "result": "PASSED",
        "comments": "Playwright run #1482, commit a1b2c3d",
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/test_step_executions?page[size]=25",
    "first": "/test_step_executions?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/test_step_executions?page[size]=25&page[number]=2",
    "last": "/test_step_executions?page[size]=25&page[number]=6"
  },
  "meta": {
    "totalCount": 128
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Count and aggregate test step executions

GET/api/v1/test_step_executions/aggregate

Aggregates test step execution resources - a count and per-column aggregations, optionally grouped - over the same filter the collection route accepts.

Query parameters

aggregations[count]boolean: Include the row count in the aggregate result. When no aggregation is requested at all, the runtime defaults to count.
aggregations[sum][]string[]: Column(s) to sum - repeat the bracketed key per column (aggregations[sum][]=a&aggregations[sum][]=b). Permitted columns: testStepVersion, snapshotSequenceNumber.
aggregations[avg][]string[]: Column(s) to average - repeat the bracketed key per column (aggregations[avg][]=a&aggregations[avg][]=b). Permitted columns: testStepVersion, snapshotSequenceNumber.
aggregations[min][]string[]: Column(s) to take the minimum of - repeat the bracketed key per column (aggregations[min][]=a&aggregations[min][]=b). Permitted columns: testStepVersion, actualResult, comments, snapshotSequenceNumber, snapshotAction, snapshotTestData, snapshotExpectedResult, snapshotBddContent, createdAt, updatedAt.
aggregations[max][]string[]: Column(s) to take the maximum of - repeat the bracketed key per column (aggregations[max][]=a&aggregations[max][]=b). Permitted columns: testStepVersion, actualResult, comments, snapshotSequenceNumber, snapshotAction, snapshotTestData, snapshotExpectedResult, snapshotBddContent, createdAt, updatedAt.
aggregations[groupBy][]string[]: Column(s) to group by - repeating the bracketed key switches the response to the grouped shape (aggregations[groupBy][]=a&aggregations[groupBy][]=b). Permitted columns: id, organizationId, projectId, result, testCaseExecutionId, testStepId.
filterstring: A FiltrQL expression, url-encoded. Combine conditions with AND / OR and parentheses. The fields you can filter on, and the operators each accepts, are listed under Filterable fields.; result = "NOT_EXECUTED"

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Filterable fields18

Show fields and operators

Field	Type	Operators
`id`	uuid	= != in (…) not in (…) is null is not null
`organizationId`	uuid	= != in (…) not in (…) is null is not null
`projectId`	uuid	= != in (…) not in (…) is null is not null
`result`	enum	= != in (…) not in (…) is null is not nullNOT_EXECUTED, PASSED, FAILED, BLOCKED, SKIPPED
`testCaseExecutionId`	uuid	= != in (…) not in (…) is null is not null
`testStepId`	uuid	= != in (…) not in (…) is null is not null
`testStepVersion`	int	= != < <= > >= in (…) not in (…) is null is not null
`actualResult`	string	~ is null is not null is empty is not empty
`comments`	string	~ is null is not null is empty is not empty
`snapshotSequenceNumber`	int	= != < <= > >= in (…) not in (…) is null is not null
`snapshotAction`	string	~ is null is not null is empty is not empty
`snapshotTestData`	string	~ is null is not null is empty is not empty
`snapshotExpectedResult`	string	~ is null is not null is empty is not empty
`snapshotBddContent`	string	~ is null is not null is empty is not empty
`createdAt`	datetime	= != < <= > >= is null is not null
`updatedAt`	datetime	= != < <= > >= is null is not null
`createdBy`	uuid	= != in (…) not in (…) is null is not null
`updatedBy`	uuid	= != in (…) not in (…) is null is not null

Filter through a relation with ANY, ALL or NONE, for example testCaseExecution ANY (id = "…"). Relations: testCaseExecution, createdByUser, organization, project, testStep, updatedByUser.

Responses

200Success.

11 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions/aggregate?aggregations%5Bcount%5D=true" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "testStepExecutions_aggregate",
    "id": "(aggregate)",
    "attributes": {
      "count": 128
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Get a test step execution

GET/api/v1/test_step_executions/{id}

Returns the test step execution with this id as a JSON:API resource document; include embeds related resources and fields[<type>] selects the attributes returned.

Path parameters

iduuidrequired: The resource id (a UUID).

Query parameters

includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: testCaseExecution, createdByUser, organization, project, testStep, updatedByUser.; testCaseExecution
fields[test_step_executions]string[]: Sparse fieldset for resource type "test_step_executions" - comma-separated subset of its exposed fields: id, organizationId, projectId, result, testCaseExecutionId, testStepId, testStepVersion, actualResult, comments, snapshotSequenceNumber, snapshotAction, snapshotTestData, snapshotExpectedResult, snapshotBddContent, createdAt, updatedAt, createdBy, updatedBy, testCaseExecution, createdByUser, updatedByUser, organization, project, testStep.; result,testStepVersion,actualResult

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned18

actualResultstring | null
commentsstring | null
createdAtdate-timeread-only
createdByuuid | nullread-only
iduuidread-only
organizationIduuidread-only
projectIduuid
resultstringdefault NOT_EXECUTED: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Show the remaining 10

snapshotActionstring | nullread-only
snapshotBddContentstring | nullread-only
snapshotExpectedResultstring | nullread-only
snapshotSequenceNumberinteger | nullread-only
snapshotTestDatastring | nullread-only
testCaseExecutionIduuidread-only
testStepIduuidread-only
testStepVersionintegerread-only
updatedAtdate-timeread-only
updatedByuuid | nullread-only

Responses

200Success.

12 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.UNKNOWN_TYPEUNKNOWN_FIELDINCLUDE_DEPTH_EXCEEDEDUNKNOWN_RELATIONINCLUDE_RESOURCES_EXCEEDEDINPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
410Gone.GONE
415The Content-Type was not application/vnd.api+json.PARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "result": "PASSED",
      "comments": "Playwright run #1482, commit a1b2c3d",
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Update a test step execution

PATCH/api/v1/test_step_executions/{id}

Updates the test step execution with this id from a JSON:API resource object carrying only the attributes to change, and returns the updated resource. A resource that carries an ETag requires it back as If-Match.

Needs a read-and-write token. A read-only token gets 403.

Version-locked: send the ETag from your last read as If-Match.

Path parameters

iduuidrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer $BESTEST_TOKEN
Acceptstring: Send application/vnd.api+json, or leave it out. Asking for application/json returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Anything else returns 415 Unsupported Media Type.; application/vnd.api+json
If-Matchstringrequired: The ETag from your last read of this resource, sent back verbatim. Missing returns 428 Precondition Required; stale (someone changed it since you read it) returns 412 Precondition Failed. Read it again and retry.; W/"3"

Attributes you can send4

actualResultstring | null
commentsstring | null
projectIduuid
resultstringdefault NOT_EXECUTED: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Returns the same attributes as Get a test step execution.

Responses

200Success.

13 error responses

400The request is malformed: an unknown field, a filter that does not parse, or conflicting paging parameters.INPUT_DEPTH_EXCEEDEDGRAPHQL_PARSE_FAILEDGRAPHQL_VALIDATION_FAILEDBAD_USER_INPUT
401The token has expired or could not be authenticated.TOKEN_EXPIREDUNAUTHENTICATED
403The token is missing or not recognised, belongs to another region, or is read-only and this is a write.FORBIDDEN
404No such resource, or it is outside the Space your token reaches.NOT_FOUND
406The Accept header asked for something other than application/vnd.api+json.NOT_ACCEPTABLE
409The write conflicts with existing data, for example a duplicate or a reference to something that does not exist.UNIQUE_VIOLATIONFOREIGN_KEY_VIOLATIONCONFLICT
412The If-Match ETag is stale: the resource changed since you read it. Read it again and retry.STALE_OBJECT
415The Content-Type was not application/vnd.api+json.MISSING_CONTENT_TYPEINVALID_CONTENT_TYPEINVALID_CONTENT_TYPE_PARAMSPARAMETERIZED_ACCEPT
422The body is well-formed but a value is invalid, such as an enum outside its list or a missing required attribute.VALIDATION_ERRORVALIDATION_FAILEDCHECK_VIOLATIONMISSING_REQUIREDATMOST_EXCEEDEDHOOK_ABORT
428This resource is version-locked: send its ETag in an If-Match header.MISSING_IF_MATCH
429Rate limited (RATE_LIMITED). Limits are per person and shared with MCP. Back off a few seconds and retry.RATE_LIMITEDQUOTA_EXCEEDED
500Server error. Safe to retry a read; check before retrying a write.INTERNAL_ERROR
503Temporarily unavailable. Retry with backoff.UNAVAILABLE

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X PATCH \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H 'If-Match: W/"3"' \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "result": "PASSED"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "result": "PASSED",
      "comments": "Playwright run #1482, commit a1b2c3d",
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Show an error response

Error

every 4xx and 5xx has this shape

{
  "errors": [
    {
      "status": "400",
      "title": "Bad Request",
      "code": "UNKNOWN_FIELD",
      "detail": "Unknown field \"displayName\" on resource type \"users\". Valid fields: id, externalId, role, ...",
      "source": {
        "parameter": "fields[users]"
      }
    }
  ]
}

Related-resource endpoints

Each to-many relation has its own URL, such as a test case's steps or a cycle's executions. They return a paginated collection of the related resource and take that resource's own filter, sort, paging and fields parameters, so they are listed rather than documented one by one. For to-one relations, use ?include= on the parent request instead: one round trip instead of two.

Show all 2

GET/api/v1/test_case_executions/{id}/testCaseExecutions
GET/api/v1/test_case_executions/{id}/testStepExecutions