Skip to main content
GET
/
comments
/
v2
/
rs
/
origin
/
{originType}
/
{originId}
List comments for the given site Ids
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/comments/v2/rs/origin/{originType}/{originId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "comment": "This is a comment.",
      "metadata": {
        "key": "value"
      },
      "origin": {
        "type": 1,
        "id": 123
      },
      "updatedAt": "2025-05-06T12:00:00.000Z",
      "createdAt": "2025-05-01T09:30:00.000Z",
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      },
      "createdBy": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe"
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"

Path Parameters

​
originType
enum<number>
required

Type of entity to attach to.

Available options:
1,
2
Example:

1

​
originId
integer
required

ID of the entity to attach to.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

123

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "actions-info": Give information about actions that can be done on comments

  • "created-by": Get information about the person that created the comment

Available options:
actions-info,
created-by
​
whereComment
string

Filter by comment content (contains)

Example:

"string"

​
whereCreatedById
integer

Filter by createdBy id

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereCreatedByName
string

Filter by user name (contains)

Example:

"string"

​
whereUpdatedAt
object

Filter by update date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedAt
object

Filter by createdAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
pageSize
integer
default:50

Page size.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

50

​
findId
integer

Get the page where the item with this id is located.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

Response

200 - application/json

List of comments

​
data
object[]
required
​
totalCount
integer

Total count of items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100

​
pagination
object

Pagination information.