GET /api/v2/requests/{request_id}/comments

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:

NameTypeRequiredComments
sortstringnoPossible values are "created_at" (ascending order) or "-created_at" (descending order)

When using offset pagination, use the following parameters to change the sort order:

NameTypeRequiredComments
sort_bystringnoOne of created_at, updated_at
sort_orderstringnoOne of asc, desc

Allowed For

Servers

Path parameters

Name Type Required Description
request_id Integer Yes

The ID of the request

Query parameters

Name Type Required Description
since String No

Filters the comments from the given datetime

role String No

One of "agent", "end_user". If not specified it does not filter

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.