Listing Comments
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Sorting
By default, comments are sorted by creation date in ascending order.
When using cursor pagination, use the following parameter to change the sort order:
| Name | Type | Required | Comments |
|---|---|---|---|
| sort | string | no | Possible values are "created_at" (ascending order) or "-created_at" (descending order) |
When using offset pagination, use the following parameters to change the sort order:
| Name | Type | Required | Comments |
|---|---|---|---|
| sort_by | string | no | One of created_at, updated_at |
| sort_order | string | no | One of asc, desc |
Allowed For
- End Users
Query parameters
A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
Specifies how many records should be returned in the response. You can specify up to 100 records per page.
Specifies how to sort the comments. Possible values are "created_at" (ascending order) or "-created_at" (descending order)
Filters the comments from the given datetime
One of "agent", "end_user". If not specified it does not filter
Response
Success response