Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • organisation_eq: Filter where the organisation ID equals the provided value.
  • commentable_eq: Filter where the commentable resource ID equals the provided value.
  • commentable_type_eq: Filter where the commentable resource type equals the provided value.

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
commentable

Response

List of agent issue comments.

JSON API response object

data
A list of agent issue comments · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a comment is returned

An agent issue