BesTest Logo
BesTestTest Management for Jira
REST API reference

Comments

Discussion threads on testing objects, and their @mentions.

List comments

GET/api/v1/comments

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

authorIduuid
contentstring
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
Show the remaining 8
isEditedboolean
organizationIduuid
parentCommentIduuid | null
projectIduuid
targetEntityIduuid
targetEntityTypestring
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
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/comments?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": "comments",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "updatedAt": "2026-08-18T09:30:00Z",
        "authorId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "content": "string",
        "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "deletedAt": "2026-08-18T09:30:00Z",
        "editedAt": "2026-08-18T09:30:00Z",
        "isDeleted": true
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/comments?page[number]=1",
    "next": "/api/v1/comments?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 comment

POST/api/v1/comments

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

authorIduuidrequired
contentstringrequired
organizationIduuidrequired
projectIduuidrequired
targetEntityIduuidrequired
targetEntityTypestringrequired
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
isEditedboolean
parentCommentIduuid | null
updatedAtdate-time
updatedByuuid | null

Attributes returned16

authorIduuid
contentstring
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
Show the remaining 8
isEditedboolean
organizationIduuid
parentCommentIduuid | null
projectIduuid
targetEntityIduuid
targetEntityTypestring
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
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/comments" \
  -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": "comments",
    "attributes": {
      "authorId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "content": "string",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "projectId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "targetEntityId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "targetEntityType": "TEST_CASE"
    }
  }
}'
Response

application/vnd.api+json

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

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

authorIduuid
contentstring
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
Show the remaining 8
isEditedboolean
organizationIduuid
parentCommentIduuid | null
projectIduuid
targetEntityIduuid
targetEntityTypestring
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
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/comments/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": "comments",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "authorId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "content": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "deletedAt": "2026-08-18T09:30:00Z",
      "editedAt": "2026-08-18T09:30:00Z",
      "isDeleted": true
    }
  }
}
Show an error response
Error

any 4xx

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

Update a comment

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

authorIduuid
contentstring
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
isEditedboolean
organizationIduuid
parentCommentIduuid | null
projectIduuid
targetEntityIduuid
targetEntityTypestring
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
updatedAtdate-time
updatedByuuid | null

Attributes returned16

authorIduuid
contentstring
createdAtdate-time
createdByuuid | null
deletedAtdate-time | null
editedAtdate-time | null
iduuid
isDeletedboolean
Show the remaining 8
isEditedboolean
organizationIduuid
parentCommentIduuid | null
projectIduuid
targetEntityIduuid
targetEntityTypestring
TEST_CASETEST_CYCLETEST_CASE_EXECUTIONREQUIREMENTTEST_COLLECTIONTEST_CAMPAIGNTEST_CASE_REVIEW
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/comments/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": "comments",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "authorId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "content": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "deletedAt": "2026-08-18T09:30:00Z"
    }
  }
}'
Response

application/vnd.api+json

{
  "data": {
    "type": "comments",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "updatedAt": "2026-08-18T09:30:00Z",
      "authorId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "content": "string",
      "createdBy": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "deletedAt": "2026-08-18T09:30:00Z",
      "editedAt": "2026-08-18T09:30:00Z",
      "isDeleted": true
    }
  }
}
Show an error response
Error

any 4xx

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

Delete a comment

DEL/api/v1/comments/{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/comments/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": "comments",
    "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 comments

GET/api/v1/comments/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/comments/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 comment mentions

GET/api/v1/comment_mentions

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 returned5

commentIduuid
createdAtdate-time
iduuid
mentionedUserIduuid
organizationIduuid

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/comment_mentions?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": "comment_mentions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/comment_mentions?page[number]=1",
    "next": "/api/v1/comment_mentions?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 comment mention

POST/api/v1/comment_mentions

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 send5

commentIduuidrequired
mentionedUserIduuidrequired
organizationIduuidrequired
createdAtdate-time
iduuid

Attributes returned5

commentIduuid
createdAtdate-time
iduuid
mentionedUserIduuid
organizationIduuid

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/comment_mentions" \
  -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": "comment_mentions",
    "attributes": {
      "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "createdAt": "2026-08-18T09:30:00Z"
    }
  }
}'
Response

application/vnd.api+json

{
  "data": [
    {
      "type": "comment_mentions",
      "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "attributes": {
        "createdAt": "2026-08-18T09:30:00Z",
        "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
        "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
      }
    }
  ],
  "meta": {
    "totalCount": 128
  },
  "links": {
    "first": "/api/v1/comment_mentions?page[number]=1",
    "next": "/api/v1/comment_mentions?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 comment mention

GET/api/v1/comment_mentions/{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 returned5

commentIduuid
createdAtdate-time
iduuid
mentionedUserIduuid
organizationIduuid

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/comment_mentions/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": "comment_mentions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "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 comment mention

PATCH/api/v1/comment_mentions/{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 send5

commentIduuid
createdAtdate-time
iduuid
mentionedUserIduuid
organizationIduuid

Attributes returned5

commentIduuid
createdAtdate-time
iduuid
mentionedUserIduuid
organizationIduuid

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/comment_mentions/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": "comment_mentions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33"
    }
  }
}'
Response

application/vnd.api+json

{
  "data": {
    "type": "comment_mentions",
    "id": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
    "attributes": {
      "createdAt": "2026-08-18T09:30:00Z",
      "commentId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "mentionedUserId": "3f2b9c14-8d5e-4a71-9f60-2c1e7b4a8d33",
      "organizationId": "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 comment mention

DEL/api/v1/comment_mentions/{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/comment_mentions/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": "comment_mentions",
    "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 comment mentions

GET/api/v1/comment_mentions/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/comment_mentions/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 18
  • GET/api/v1/comments/{id}/comment
  • GET/api/v1/comments/{id}/fkCommentsAuthorUser
  • GET/api/v1/comments/{id}/fkCommentsCreatedByUser
  • GET/api/v1/comments/{id}/fkCommentsUpdatedByUser
  • GET/api/v1/comments/{id}/organization
  • GET/api/v1/comments/{id}/project
  • GET/api/v1/comments/{id}/relationships/comment
  • GET/api/v1/comments/{id}/relationships/fkCommentsAuthorUser
  • GET/api/v1/comments/{id}/relationships/fkCommentsCreatedByUser
  • GET/api/v1/comments/{id}/relationships/fkCommentsUpdatedByUser
  • GET/api/v1/comments/{id}/relationships/organization
  • GET/api/v1/comments/{id}/relationships/project
  • GET/api/v1/comment_mentions/{id}/comment
  • GET/api/v1/comment_mentions/{id}/organization
  • GET/api/v1/comment_mentions/{id}/user
  • GET/api/v1/comment_mentions/{id}/relationships/comment
  • GET/api/v1/comment_mentions/{id}/relationships/organization
  • GET/api/v1/comment_mentions/{id}/relationships/user