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.

List test case executions

GET/api/v1/test_case_executions

Query parameters

filterstring: A FiltrQL expression, url-encoded. Combine with AND / OR and parentheses. See the Filtering page for the full operator list, or call /filter-reference for the live one.; status = 'PASSED' AND executedAt > now-7d
sortstring: Comma-separated field list. Prefix a field with a minus for descending order.; -createdAt,name
page[number]integer: Which page to return, starting at 1.; 2
page[size]integer: Results per page. Defaults to 25, and the maximum is 100.; 50
includestring: Comma-separated relationships to side-load into the response, saving a second request. Chains up to 3 deep.; requirement,folder
fields[type]string: Return only these attributes for the named resource type - a sparse fieldset. Cuts payload size sharply on wide entities.; fields[test_cases]=name,status

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned24

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid

Show the remaining 16

organizationIduuid
preTestCaseExecutionIduuid | null
projectIduuid
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
testCaseIduuid
testCaseVersioninteger
testCycleIduuid
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_case_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "actualExecutionTime": 1,
        "assigneeId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "comments": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "environmentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "executedAt": "2026-08-18T09:30:00Z"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_case_executions?page[number]=1",
    "next": "/api/v1/test_case_executions?page[number]=2"
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Create a test case execution

POST/api/v1/test_case_executions

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

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send24

organizationIduuidrequired
projectIduuidrequired
testCaseIduuidrequired
testCaseVersionintegerrequired
testCycleIduuidrequired
actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid
preTestCaseExecutionIduuid | null
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Attributes returned24

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid

Show the remaining 16

organizationIduuid
preTestCaseExecutionIduuid | null
projectIduuid
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
testCaseIduuid
testCaseVersioninteger
testCycleIduuid
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Responses

201Created.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions" \
  -X POST \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_case_executions",
    "attributes": {
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testCaseId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testCaseVersion": 1,
      "testCycleId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "createdAt": "2026-08-18T09:30:00Z"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_case_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "actualExecutionTime": 1,
        "assigneeId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "comments": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "environmentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "executedAt": "2026-08-18T09:30:00Z"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_case_executions?page[number]=1",
    "next": "/api/v1/test_case_executions?page[number]=2"
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Get a test case execution

GET/api/v1/test_case_executions/{id}

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned24

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid

Show the remaining 16

organizationIduuid
preTestCaseExecutionIduuid | null
projectIduuid
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
testCaseIduuid
testCaseVersioninteger
testCycleIduuid
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualExecutionTime": 1,
      "assigneeId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "environmentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "executedAt": "2026-08-18T09:30:00Z"
    }
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Update a test case execution

PATCH/api/v1/test_case_executions/{id}

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

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send24

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid
organizationIduuid
preTestCaseExecutionIduuid | null
projectIduuid
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
testCaseIduuid
testCaseVersioninteger
testCycleIduuid
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Attributes returned24

actualExecutionTimeinteger | null
assigneeIduuid | null
commentsstring | null
createdAtdate-time
createdByuuid | null
environmentIduuid | null
executedAtdate-time | null
iduuid

Show the remaining 16

organizationIduuid
preTestCaseExecutionIduuid | null
projectIduuid
resultstring: NOT_EXECUTEDIN_PROGRESSPASSEDFAILEDBLOCKEDSKIPPED
sourceCollectionIduuid | null
sourceContextstring | null
sourceRequirementIduuid | null
sourceTypestring | null: MANUAL_SELECTIONCOLLECTION_MANUALCOLLECTION_RULEFOLDERBULK_IMPORTREQUIREMENT_COVERAGECOLLECTION_REQUIREMENT_COVERAGE
startedAtdate-time | null
testCaseExecutionKeystring | null
testCaseIduuid
testCaseVersioninteger
testCycleIduuid
updatedAtdate-time
updatedByuuid | null
versionIduuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X PATCH \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualExecutionTime": 1,
      "assigneeId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualExecutionTime": 1,
      "assigneeId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "environmentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "executedAt": "2026-08-18T09:30:00Z"
    }
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Delete a test case execution

DEL/api/v1/test_case_executions/{id}

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

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {}
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Aggregate test case executions

GET/api/v1/test_case_executions/aggregate

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_case_executions/aggregate" \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "meta": {
    "count": 128
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

List test step executions

GET/api/v1/test_step_executions

Query parameters

filterstring: A FiltrQL expression, url-encoded. Combine with AND / OR and parentheses. See the Filtering page for the full operator list, or call /filter-reference for the live one.; status = 'PASSED' AND executedAt > now-7d
sortstring: Comma-separated field list. Prefix a field with a minus for descending order.; -createdAt,name
page[number]integer: Which page to return, starting at 1.; 2
page[size]integer: Results per page. Defaults to 25, and the maximum is 100.; 50
includestring: Comma-separated relationships to side-load into the response, saving a second request. Chains up to 3 deep.; requirement,folder
fields[type]string: Return only these attributes for the named resource type - a sparse fieldset. Cuts payload size sharply on wide entities.; fields[test_cases]=name,status

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned18

actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
organizationIduuid
projectIduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Show the remaining 10

snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
testCaseExecutionIduuid
testStepIduuid
testStepVersioninteger
updatedAtdate-time
updatedByuuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_step_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "actualResult": "string",
        "comments": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "result": "NOT_EXECUTED"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_step_executions?page[number]=1",
    "next": "/api/v1/test_step_executions?page[number]=2"
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Create a test step execution

POST/api/v1/test_step_executions

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

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send18

organizationIduuidrequired
projectIduuidrequired
testCaseExecutionIduuidrequired
testStepIduuidrequired
testStepVersionintegerrequired
actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED
snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
updatedAtdate-time
updatedByuuid | null

Attributes returned18

actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
organizationIduuid
projectIduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Show the remaining 10

snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
testCaseExecutionIduuid
testStepIduuid
testStepVersioninteger
updatedAtdate-time
updatedByuuid | null

Responses

201Created.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions" \
  -X POST \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_step_executions",
    "attributes": {
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testCaseExecutionId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testStepId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "testStepVersion": 1,
      "createdAt": "2026-08-18T09:30:00Z"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_step_executions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "actualResult": "string",
        "comments": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "result": "NOT_EXECUTED"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_step_executions?page[number]=1",
    "next": "/api/v1/test_step_executions?page[number]=2"
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Get a test step execution

GET/api/v1/test_step_executions/{id}

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Attributes returned18

actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
organizationIduuid
projectIduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Show the remaining 10

snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
testCaseExecutionIduuid
testStepIduuid
testStepVersioninteger
updatedAtdate-time
updatedByuuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualResult": "string",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "result": "NOT_EXECUTED"
    }
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Update a test step execution

PATCH/api/v1/test_step_executions/{id}

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

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Attributes you can send18

actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
organizationIduuid
projectIduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED
snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
testCaseExecutionIduuid
testStepIduuid
testStepVersioninteger
updatedAtdate-time
updatedByuuid | null

Attributes returned18

actualResultstring | null
commentsstring | null
createdAtdate-time
createdByuuid | null
iduuid
organizationIduuid
projectIduuid
resultstring: NOT_EXECUTEDPASSEDFAILEDBLOCKEDSKIPPED

Show the remaining 10

snapshotActionstring | null
snapshotBddContentstring | null
snapshotExpectedResultstring | null
snapshotSequenceNumberinteger | null
snapshotTestDatastring | null
testCaseExecutionIduuid
testStepIduuid
testStepVersioninteger
updatedAtdate-time
updatedByuuid | null

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X PATCH \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualResult": "string",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "actualResult": "string",
      "comments": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "result": "NOT_EXECUTED"
    }
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Delete a test step execution

DEL/api/v1/test_step_executions/{id}

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

Path parameters

idstringrequired: The resource id (a UUID).

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json
Content-Typestringrequired: Must be application/vnd.api+json on any request with a body. Any other value returns 415 Unsupported Media Type.; application/vnd.api+json

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

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

Response

application/vnd.api+json

{
  "data": {
    "type": "test_step_executions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {}
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Aggregate test step executions

GET/api/v1/test_step_executions/aggregate

Headers

Authorizationstringrequired: Your API token as a bearer credential.; Bearer bst_pat_YOUR_TOKEN_HERE
Acceptstringrequired: Must be application/vnd.api+json. Any other value returns 406 Not Acceptable.; application/vnd.api+json

Responses

200OK.
403The token is missing, expired, revoked, aimed at another Space, or lacks write access.
404No such resource, or it is outside the Space your token reaches.
406The Accept header did not include application/vnd.api+json.
429Rate limit exceeded: 100 requests a minute per token, shared with MCP.

Request

curl

curl "https://prod-eu.getbestest.com/api/v1/test_step_executions/aggregate" \
  -H "Authorization: Bearer bst_pat_YOUR_TOKEN_HERE" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "meta": {
    "count": 128
  }
}

Show an error response

Error

any 4xx

{
  "errors": [
    {
      "status": "403",
      "title": "Forbidden",
      "code": "FORBIDDEN",
      "detail": "Access denied.",
      "source": {
        "pointer": "/data"
      }
    }
  ]
}

Relationship endpoints

JSON:API exposes each relationship at its own URL. They take the same headers and return the same envelope as everything above, so they are listed rather than documented one by one. In most cases ?include= on the parent request is the better tool: one round trip instead of two.

Show all 36

GET/api/v1/test_case_executions/{id}/environment
GET/api/v1/test_case_executions/{id}/fkTestCaseExecutionsAssigneeUser
GET/api/v1/test_case_executions/{id}/fkTestCaseExecutionsCreatedByUser
GET/api/v1/test_case_executions/{id}/fkTestCaseExecutionsUpdatedByUser
GET/api/v1/test_case_executions/{id}/organization
GET/api/v1/test_case_executions/{id}/project
GET/api/v1/test_case_executions/{id}/requirement
GET/api/v1/test_case_executions/{id}/testCase
GET/api/v1/test_case_executions/{id}/testCaseExecution
GET/api/v1/test_case_executions/{id}/testCollection
GET/api/v1/test_case_executions/{id}/testCycle
GET/api/v1/test_case_executions/{id}/version
GET/api/v1/test_case_executions/{id}/relationships/environment
GET/api/v1/test_case_executions/{id}/relationships/fkTestCaseExecutionsAssigneeUser
GET/api/v1/test_case_executions/{id}/relationships/fkTestCaseExecutionsCreatedByUser
GET/api/v1/test_case_executions/{id}/relationships/fkTestCaseExecutionsUpdatedByUser
GET/api/v1/test_case_executions/{id}/relationships/organization
GET/api/v1/test_case_executions/{id}/relationships/project
GET/api/v1/test_case_executions/{id}/relationships/requirement
GET/api/v1/test_case_executions/{id}/relationships/testCase
GET/api/v1/test_case_executions/{id}/relationships/testCaseExecution
GET/api/v1/test_case_executions/{id}/relationships/testCollection
GET/api/v1/test_case_executions/{id}/relationships/testCycle
GET/api/v1/test_case_executions/{id}/relationships/version
GET/api/v1/test_step_executions/{id}/fkTestStepExecutionsCreatedByUser
GET/api/v1/test_step_executions/{id}/fkTestStepExecutionsUpdatedByUser
GET/api/v1/test_step_executions/{id}/organization
GET/api/v1/test_step_executions/{id}/project
GET/api/v1/test_step_executions/{id}/testCaseExecution
GET/api/v1/test_step_executions/{id}/testStep
GET/api/v1/test_step_executions/{id}/relationships/fkTestStepExecutionsCreatedByUser
GET/api/v1/test_step_executions/{id}/relationships/fkTestStepExecutionsUpdatedByUser
GET/api/v1/test_step_executions/{id}/relationships/organization
GET/api/v1/test_step_executions/{id}/relationships/project
GET/api/v1/test_step_executions/{id}/relationships/testCaseExecution
GET/api/v1/test_step_executions/{id}/relationships/testStep