Links and traceability

Links are how traceability is built: requirement to test case, test case to Jira work item, a failed execution to the bug it raised. Each link names a source and a target by type and id. A Jira work item is represented by an issue row carrying its key, so link to a work item by creating (or finding) its issue first.

List links

GET/api/v1/links

Lists link 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.; sourceType = "TEST_CASE"
sortstring: Comma-separated sort fields; prefix a field with "-" for descending order (e.g. "-createdAt,title"). Permitted fields: id, organizationId, projectId, sourceId, sourceType, targetId, targetType, sourceProjectExternalId, targetProjectExternalId, sourceProjectId, targetProjectId.; -sourceType
includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: createdByUser, organization, project, updatedByUser.; createdByUser
fields[links]string[]: Sparse fieldset for resource type "links" - comma-separated subset of its exposed fields: id, organizationId, projectId, sourceId, sourceType, targetId, targetType, description, createdAt, updatedAt, createdBy, updatedBy, sourceProjectExternalId, targetProjectExternalId, sourceProjectId, targetProjectId, createdByUser, updatedByUser, organization, project.; sourceType,targetType,description
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 fields16

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
`sourceId`	uuid	= != in (…) not in (…) is null is not null
`sourceType`	enum	= != in (…) not in (…) is null is not nullISSUE, REQUIREMENT, TEST_CASE, TEST_CYCLE, TEST_CASE_EXECUTION, TEST_STEP_EXECUTION
`targetId`	uuid	= != in (…) not in (…) is null is not null
`targetType`	enum	= != in (…) not in (…) is null is not nullISSUE, REQUIREMENT, TEST_CASE, TEST_CYCLE, TEST_CASE_EXECUTION, TEST_STEP_EXECUTION
`description`	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
`sourceProjectExternalId`	string	= != in (…) not in (…) is null is not null
`targetProjectExternalId`	string	= != in (…) not in (…) is null is not null
`sourceProjectId`	uuid	= != in (…) not in (…) is null is not null
`targetProjectId`	uuid	= != in (…) not in (…) is null is not null

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

Returns the same attributes as Get a link.

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/links?page%5Bsize%5D=25" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "links",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/links/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/links?page[size]=25",
    "first": "/links?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/links?page[size]=25&page[number]=2",
    "last": "/links?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 link

POST/api/v1/links

Creates a link 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 send6

projectIduuidrequired
sourceIduuidrequired
sourceTypestringrequired: ISSUEREQUIREMENTTEST_CASETEST_CYCLETEST_CASE_EXECUTIONTEST_STEP_EXECUTION
targetIduuidrequired
targetTypestringrequired: ISSUEREQUIREMENTTEST_CASETEST_CYCLETEST_CASE_EXECUTIONTEST_STEP_EXECUTION
descriptionstring | null

Returns the same attributes as Get a link.

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/links" \
  -X POST \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "links",
    "attributes": {
      "projectId": "03ff802c-4fcb-4718-8eb8-12ecc999f758",
      "sourceId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "sourceType": "ISSUE",
      "targetId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "targetType": "ISSUE"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "links",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/links/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/links?page[size]=25",
    "first": "/links?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/links?page[size]=25&page[number]=2",
    "last": "/links?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 links

GET/api/v1/links/aggregate

Aggregates link 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[min][]string[]: Column(s) to take the minimum of - repeat the bracketed key per column (aggregations[min][]=a&aggregations[min][]=b). Permitted columns: description, createdAt, updatedAt, sourceProjectExternalId, targetProjectExternalId.
aggregations[max][]string[]: Column(s) to take the maximum of - repeat the bracketed key per column (aggregations[max][]=a&aggregations[max][]=b). Permitted columns: description, createdAt, updatedAt, sourceProjectExternalId, targetProjectExternalId.
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, sourceId, sourceType, targetId, targetType, sourceProjectExternalId, targetProjectExternalId, sourceProjectId, targetProjectId.
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.; sourceType = "TEST_CASE"

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 fields16

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
`sourceId`	uuid	= != in (…) not in (…) is null is not null
`sourceType`	enum	= != in (…) not in (…) is null is not nullISSUE, REQUIREMENT, TEST_CASE, TEST_CYCLE, TEST_CASE_EXECUTION, TEST_STEP_EXECUTION
`targetId`	uuid	= != in (…) not in (…) is null is not null
`targetType`	enum	= != in (…) not in (…) is null is not nullISSUE, REQUIREMENT, TEST_CASE, TEST_CYCLE, TEST_CASE_EXECUTION, TEST_STEP_EXECUTION
`description`	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
`sourceProjectExternalId`	string	= != in (…) not in (…) is null is not null
`targetProjectExternalId`	string	= != in (…) not in (…) is null is not null
`sourceProjectId`	uuid	= != in (…) not in (…) is null is not null
`targetProjectId`	uuid	= != in (…) not in (…) is null is not null

Filter through a relation with ANY, ALL or NONE, for example createdByUser ANY (id = "…"). Relations: createdByUser, organization, project, 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/links/aggregate?aggregations%5Bcount%5D=true" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "links_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 link

GET/api/v1/links/{id}

Returns the link 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: createdByUser, organization, project, updatedByUser.; createdByUser
fields[links]string[]: Sparse fieldset for resource type "links" - comma-separated subset of its exposed fields: id, organizationId, projectId, sourceId, sourceType, targetId, targetType, description, createdAt, updatedAt, createdBy, updatedBy, sourceProjectExternalId, targetProjectExternalId, sourceProjectId, targetProjectId, createdByUser, updatedByUser, organization, project.; sourceType,targetType,description

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 returned16

createdAtdate-timeread-only
createdByuuid | nullread-only
descriptionstring | null
iduuidread-only
organizationIduuidread-only
projectIduuid
sourceIduuid
sourceProjectExternalIdstringread-only

Show the remaining 8

sourceProjectIduuidread-only
sourceTypestring: ISSUEREQUIREMENTTEST_CASETEST_CYCLETEST_CASE_EXECUTIONTEST_STEP_EXECUTION
targetIduuid
targetProjectExternalIdstringread-only
targetProjectIduuidread-only
targetTypestring: ISSUEREQUIREMENTTEST_CASETEST_CYCLETEST_CASE_EXECUTIONTEST_STEP_EXECUTION
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/links/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "links",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/links/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]"
      }
    }
  ]
}

Delete a link

DEL/api/v1/links/{id}

Deletes the link with this id.

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
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"

Responses

204Done. No body.

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.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
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/links/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X DELETE \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H 'If-Match: W/"3"'

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 issues

GET/api/v1/issues

Lists issue 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.
sortstring: Comma-separated sort fields; prefix a field with "-" for descending order (e.g. "-createdAt,title"). Permitted fields: id, organizationId, projectId, externalId, provider.; -provider
includestring: Comma-separated relation names to include; dot-notation for nested includes (up to 3 levels deep). Permitted top-level relations: createdByUser, organization, project, updatedByUser.; createdByUser
fields[issues]string[]: Sparse fieldset for resource type "issues" - comma-separated subset of its exposed fields: id, organizationId, projectId, externalId, createdAt, updatedAt, createdBy, updatedBy, provider, createdByUser, updatedByUser, organization, project.; createdAt,updatedAt,createdBy
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 fields9

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
`externalId`	string	= != 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
`provider`	string	= != in (…) not in (…) is null is not null

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

Returns the same attributes as Get an issue.

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/issues?page%5Bsize%5D=25" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "issues",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/issues/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/issues?page[size]=25",
    "first": "/issues?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/issues?page[size]=25&page[number]=2",
    "last": "/issues?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 an issue

POST/api/v1/issues

Creates a issue 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 send3

externalIdstringrequired
projectIduuidrequired
providerstringdefault jira

Returns the same attributes as Get an issue.

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/issues" \
  -X POST \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
  "data": {
    "type": "issues",
    "attributes": {
      "externalId": "KAN-118",
      "projectId": "03ff802c-4fcb-4718-8eb8-12ecc999f758"
    }
  }
}'

Response

application/vnd.api+json

{
  "data": [
    {
      "type": "issues",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "updatedAt": "2026-10-05T09:30:00Z"
      },
      "links": {
        "self": "/issues/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "links": {
    "self": "/issues?page[size]=25",
    "first": "/issues?page[size]=25&page[number]=1",
    "prev": null,
    "next": "/issues?page[size]=25&page[number]=2",
    "last": "/issues?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 issues

GET/api/v1/issues/aggregate

Aggregates issue 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[min][]string[]: Column(s) to take the minimum of - repeat the bracketed key per column (aggregations[min][]=a&aggregations[min][]=b). Permitted columns: externalId, createdAt, updatedAt, provider.
aggregations[max][]string[]: Column(s) to take the maximum of - repeat the bracketed key per column (aggregations[max][]=a&aggregations[max][]=b). Permitted columns: externalId, createdAt, updatedAt, provider.
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, externalId, provider.
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.

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 fields9

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
`externalId`	string	= != 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
`provider`	string	= != in (…) not in (…) is null is not null

Filter through a relation with ANY, ALL or NONE, for example createdByUser ANY (id = "…"). Relations: createdByUser, organization, project, 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/issues/aggregate?aggregations%5Bcount%5D=true" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "issues_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 an issue

GET/api/v1/issues/{id}

Returns the issue 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: createdByUser, organization, project, updatedByUser.; createdByUser
fields[issues]string[]: Sparse fieldset for resource type "issues" - comma-separated subset of its exposed fields: id, organizationId, projectId, externalId, createdAt, updatedAt, createdBy, updatedBy, provider, createdByUser, updatedByUser, organization, project.; createdAt,updatedAt,createdBy

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 returned9

createdAtdate-timeread-only
createdByuuid | nullread-only
externalIdstring
iduuidread-only
organizationIduuidread-only
projectIduuid
providerstringdefault jira
updatedAtdate-timeread-only

Show the remaining 1

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/issues/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json"

Response

application/vnd.api+json

{
  "data": {
    "type": "issues",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "updatedAt": "2026-10-05T09:30:00Z"
    },
    "links": {
      "self": "/issues/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]"
      }
    }
  ]
}

Delete an issue

DEL/api/v1/issues/{id}

Deletes the issue with this id.

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
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"

Responses

204Done. No body.

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.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
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/issues/3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33" \
  -X DELETE \
  -H "Authorization: Bearer $BESTEST_TOKEN" \
  -H "Accept: application/vnd.api+json" \
  -H 'If-Match: W/"3"'

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]"
      }
    }
  ]
}