Test cases

A test case holds either traditional steps or a BDD (Gherkin) body, chosen per case. Steps are separate resources, so a step can be read and updated without rewriting the whole case.

List test cases

GET/api/v1/test_cases

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 returned29

automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null

Show the remaining 21

folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
namestring
objectivestring | null
organizationIduuid
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
projectIduuid
rankinteger
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

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_cases?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_cases",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "name": "Checkout rejects an expired card",
        "status": "DRAFT",
        "description": "Given a card past its expiry date, the payment is refused.",
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "automationKey": "KAN-TC-42",
        "automationStatus": "MANUAL",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_cases?page[number]=1",
    "next": "/api/v1/test_cases?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

POST/api/v1/test_cases

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 send29

namestringrequired
organizationIduuidrequired
projectIduuidrequired
rankintegerrequired
automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null
folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
objectivestring | null
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

Attributes returned29

automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null

Show the remaining 21

folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
namestring
objectivestring | null
organizationIduuid
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
projectIduuid
rankinteger
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

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_cases" \
  -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_cases",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "rank": 1,
      "status": "DRAFT",
      "description": "Given a card past its expiry date, the payment is refused."
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_cases",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "name": "Checkout rejects an expired card",
        "status": "DRAFT",
        "description": "Given a card past its expiry date, the payment is refused.",
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "automationKey": "KAN-TC-42",
        "automationStatus": "MANUAL",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_cases?page[number]=1",
    "next": "/api/v1/test_cases?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

GET/api/v1/test_cases/{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 returned29

automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null

Show the remaining 21

folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
namestring
objectivestring | null
organizationIduuid
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
projectIduuid
rankinteger
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

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_cases/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_cases",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "status": "DRAFT",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "automationKey": "KAN-TC-42",
      "automationStatus": "MANUAL",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}

Show an error response

Error

any 4xx

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

Update a test case

PATCH/api/v1/test_cases/{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 send29

automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null
folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
namestring
objectivestring | null
organizationIduuid
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
projectIduuid
rankinteger
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

Attributes returned29

automationKeystring | null
automationStatusstring | null: MANUALAUTOMATEDTO_BE_AUTOMATEDNOT_AUTOMATABLE
createdAtdate-time
createdByuuid | null
customFieldsany
deletedAtdate-time | null
descriptionstring | null
expectedResultsstring | null

Show the remaining 21

folderIduuid | null
formatModestring: TRADITIONALBDD
formatModeChangedAtdate-time | null
formatModeChangedByuuid | null
iduuid
namestring
objectivestring | null
organizationIduuid
ownerIduuid | null
plannedTimeinteger | null
preconditionsstring | null
prioritystring | null: CRITICALHIGHMEDIUMLOW
projectIduuid
rankinteger
statusstring: DRAFTIN_REVIEWCHANGE_NEEDEDACTIVEARCHIVED
testCaseKeystring | null
testCaseKeyNumericinteger | null
typestring | null: FUNCTIONALINTEGRATIONREGRESSIONSMOKEPERFORMANCESECURITYUSABILITYEXPLORATORY
updatedAtdate-time
updatedByuuid | null
versioninteger

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_cases/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_cases",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "status": "DRAFT",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "automationKey": "KAN-TC-42"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_cases",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "status": "DRAFT",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "automationKey": "KAN-TC-42",
      "automationStatus": "MANUAL",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}

Show an error response

Error

any 4xx

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

Delete a test case

DEL/api/v1/test_cases/{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_cases/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_cases",
    "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 cases

GET/api/v1/test_cases/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_cases/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"
      }
    }
  ]
}

Describe the test case schema

GET/api/v1/test_cases/schema

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

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_cases/schema?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_cases",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {}
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_cases?page[number]=1",
    "next": "/api/v1/test_cases?page[number]=2"
  }
}

Show an error response

Error

any 4xx

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

List test steps

GET/api/v1/test_steps

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 returned16

actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid

Show the remaining 8

organizationIduuid
projectIduuid
sequenceNumberinteger
testCaseIduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

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_steps?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_steps",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "action": "string",
        "archived": true,
        "bddContent": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "deletedAt": "2026-08-18T09:30:00Z",
        "expectedResult": "string"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_steps?page[number]=1",
    "next": "/api/v1/test_steps?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

POST/api/v1/test_steps

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 send16

organizationIduuidrequired
projectIduuidrequired
sequenceNumberintegerrequired
testCaseIduuidrequired
actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

Attributes returned16

actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid

Show the remaining 8

organizationIduuid
projectIduuid
sequenceNumberinteger
testCaseIduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

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_steps" \
  -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_steps",
    "attributes": {
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "sequenceNumber": 1,
      "testCaseId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_steps",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "action": "string",
        "archived": true,
        "bddContent": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "deletedAt": "2026-08-18T09:30:00Z",
        "expectedResult": "string"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_steps?page[number]=1",
    "next": "/api/v1/test_steps?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

GET/api/v1/test_steps/{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 returned16

actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid

Show the remaining 8

organizationIduuid
projectIduuid
sequenceNumberinteger
testCaseIduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

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_steps/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_steps",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "action": "string",
      "archived": true,
      "bddContent": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "deletedAt": "2026-08-18T09:30:00Z",
      "expectedResult": "string"
    }
  }
}

Show an error response

Error

any 4xx

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

Update a test step

PATCH/api/v1/test_steps/{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 send16

actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid
organizationIduuid
projectIduuid
sequenceNumberinteger
testCaseIduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

Attributes returned16

actionstring | null
archivedboolean
bddContentstring | null
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
expectedResultstring | null
iduuid

Show the remaining 8

organizationIduuid
projectIduuid
sequenceNumberinteger
testCaseIduuid
testDatastring | null
updatedAtdate-time
updatedByuuid | null
versioninteger

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_steps/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_steps",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "action": "string",
      "archived": true,
      "bddContent": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_steps",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "action": "string",
      "archived": true,
      "bddContent": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "deletedAt": "2026-08-18T09:30:00Z",
      "expectedResult": "string"
    }
  }
}

Show an error response

Error

any 4xx

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

Delete a test step

DEL/api/v1/test_steps/{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_steps/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_steps",
    "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 steps

GET/api/v1/test_steps/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_steps/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 case folders

GET/api/v1/test_case_folders

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 returned11

createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
namestring
organizationIduuid
parentFolderIduuid | null
projectIduuid

Show the remaining 3

rankinteger
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_case_folders?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_folders",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "name": "Checkout rejects an expired card",
        "description": "Given a card past its expiry date, the payment is refused.",
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "parentFolderId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_case_folders?page[number]=1",
    "next": "/api/v1/test_case_folders?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 folder

POST/api/v1/test_case_folders

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 send11

namestringrequired
organizationIduuidrequired
projectIduuidrequired
rankintegerrequired
createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
parentFolderIduuid | null
updatedAtdate-time
updatedByuuid | null

Attributes returned11

createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
namestring
organizationIduuid
parentFolderIduuid | null
projectIduuid

Show the remaining 3

rankinteger
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_case_folders" \
  -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_folders",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "rank": 1,
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "test_case_folders",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "name": "Checkout rejects an expired card",
        "description": "Given a card past its expiry date, the payment is refused.",
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "parentFolderId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/test_case_folders?page[number]=1",
    "next": "/api/v1/test_case_folders?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 folder

GET/api/v1/test_case_folders/{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 returned11

createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
namestring
organizationIduuid
parentFolderIduuid | null
projectIduuid

Show the remaining 3

rankinteger
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_case_folders/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_folders",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "parentFolderId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}

Show an error response

Error

any 4xx

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

Update a test case folder

PATCH/api/v1/test_case_folders/{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 send11

createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
namestring
organizationIduuid
parentFolderIduuid | null
projectIduuid
rankinteger
updatedAtdate-time
updatedByuuid | null

Attributes returned11

createdAtdate-time
createdByuuid | null
descriptionstring | null
iduuid
namestring
organizationIduuid
parentFolderIduuid | null
projectIduuid

Show the remaining 3

rankinteger
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_case_folders/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_folders",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": {
    "type": "test_case_folders",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "name": "Checkout rejects an expired card",
      "description": "Given a card past its expiry date, the payment is refused.",
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "parentFolderId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}

Show an error response

Error

any 4xx

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

Delete a test case folder

DEL/api/v1/test_case_folders/{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_folders/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_folders",
    "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 folders

GET/api/v1/test_case_folders/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_folders/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_cases/{id}/fkTestCasesCreatedByUser
GET/api/v1/test_cases/{id}/fkTestCasesFormatChangedByUser
GET/api/v1/test_cases/{id}/fkTestCasesOwnerUser
GET/api/v1/test_cases/{id}/fkTestCasesUpdatedByUser
GET/api/v1/test_cases/{id}/organization
GET/api/v1/test_cases/{id}/project
GET/api/v1/test_cases/{id}/testCaseFolder
POST/api/v1/test_cases/{id}/actions/restore
GET/api/v1/test_cases/{id}/relationships/fkTestCasesCreatedByUser
GET/api/v1/test_cases/{id}/relationships/fkTestCasesFormatChangedByUser
GET/api/v1/test_cases/{id}/relationships/fkTestCasesOwnerUser
GET/api/v1/test_cases/{id}/relationships/fkTestCasesUpdatedByUser
GET/api/v1/test_cases/{id}/relationships/organization
GET/api/v1/test_cases/{id}/relationships/project
GET/api/v1/test_cases/{id}/relationships/testCaseFolder
GET/api/v1/test_steps/{id}/fkTestStepsCreatedByUser
GET/api/v1/test_steps/{id}/fkTestStepsUpdatedByUser
GET/api/v1/test_steps/{id}/organization
GET/api/v1/test_steps/{id}/project
GET/api/v1/test_steps/{id}/testCase
POST/api/v1/test_steps/{id}/actions/restore
GET/api/v1/test_steps/{id}/relationships/fkTestStepsCreatedByUser
GET/api/v1/test_steps/{id}/relationships/fkTestStepsUpdatedByUser
GET/api/v1/test_steps/{id}/relationships/organization
GET/api/v1/test_steps/{id}/relationships/project
GET/api/v1/test_steps/{id}/relationships/testCase
GET/api/v1/test_case_folders/{id}/fkTestCaseFoldersCreatedByUser
GET/api/v1/test_case_folders/{id}/fkTestCaseFoldersUpdatedByUser
GET/api/v1/test_case_folders/{id}/organization
GET/api/v1/test_case_folders/{id}/project
GET/api/v1/test_case_folders/{id}/testCaseFolder
GET/api/v1/test_case_folders/{id}/relationships/fkTestCaseFoldersCreatedByUser
GET/api/v1/test_case_folders/{id}/relationships/fkTestCaseFoldersUpdatedByUser
GET/api/v1/test_case_folders/{id}/relationships/organization
GET/api/v1/test_case_folders/{id}/relationships/project
GET/api/v1/test_case_folders/{id}/relationships/testCaseFolder