Get mention list

This endpoint enables you to retrieve the list of mentions for a specific comment. Fetching the mention list allows you to see which participants are mentioned in a comment.

How to use

You can use the following cURL to obtain a response on the endpoint:

curl --location --request GET https://api.superviz.com/threads/comments/{commentId}/mentions \
  --header 'Content-Type: application/json' \
  --header "client_id: ${YOUR CLIENT_ID}" \
  --header "secret: ${YOUR SECRET}"

In the request, you will need to send in the path following field:

Name	Description
commentId	Required. The ID of the comment.

Headers

When using this endpoint, you need to provide the Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Response

Status code 200 will indicate that the mention list was fetched successfully.

Name	Type	Description
commentId	string	The ID of the comment.
participantId	string	The ID of the participant.
createdAt	string	The date and time when the mention was created.
threadId	string	The ID of the thread.
readed	number	The number of times the mention has been read.

Example:

[
    {
        "commentId": "08fb673d-3b82-4847-9367-4bae347b352f",
        "participantId": "usr12345",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "threadId": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
        "readed": 0
    }
]