API v1
v1
View as Markdown

List the comments of a change

GET /api/v1/changelog-entries/{entry}/comments

List the comments you can read under a change, oldest first.

You read the public comments, except those an administrator hid, and every comment of your own, private or hidden. The list is whole rather than paginated.

This endpoint also answers QUERY, with the same parameters sent in the request body. How QUERY works.

Path parameters

Sent as JSON. Anything not listed here is ignored.

entry string Required

The identifier of the change, the 26 characters it reports as id. A change that does not exist or is not published yet answers 404.

Returns

Every comment object you can read, or an empty list. A change that does not exist answers 404.

data array

Every comment you can read under the change, whole rather than a page at a time.

data[] object

One comment.

data[].type string

Always changelog_comment. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data[].id string

The identifier of this comment.

data[].attributes object

Everything the comment holds.

data[].attributes.author_name string

The name of the person who wrote it, or Anonymous, in your language, when they chose not to show it. An anonymous comment shows Anonymous to everybody, its author included.

data[].attributes.is_mine boolean

Whether you wrote it.

data[].attributes.is_private boolean

Whether only the administrators of the instance read it. Only its author sees a private comment in this list.

data[].attributes.is_anonymous boolean

Whether it is shown without the name of its author. A private comment is never anonymous.

data[].attributes.body string

The comment, as plain text.

data[].attributes.replies array

The public answers of the administrators, oldest first, or an empty list.

data[].attributes.created_at timestamp

When the comment was written, as a count of seconds since 1970.

data[].attributes.updated_at timestamp

When the comment last changed, as a count of seconds since 1970.

data[].attributes.replies[] object

One answer.

data[].attributes.replies[].author_name string

The name the administrator answered under.

data[].attributes.replies[].body string

The answer, as plain text.

data[].attributes.replies[].created_at timestamp

When the answer was written, as a count of seconds since 1970.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

GET
curl https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK5XNH908RFDGEAJXKN/comments \
-H "Authorization: Bearer $MONICA_TOKEN"
const response = await fetch('https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK5XNH908RFDGEAJXKN/comments', {
headers: { Authorization: `Bearer ${token}` },
})
const data = await response.json()
$response = Http::withToken($token)->get('https://my.monicahq.com/api/v1/changelog-entries/01M7NBFWK5XNH908RFDGEAJXKN/comments');
Response 200
{
"data": [
{
"type": "changelog_comment",
"id": "6b2f9d41-8c37-4e05-a1d6-3f9e7c2b5a84",
"attributes": {
"author_name": "Dwight Schrute",
"is_mine": true,
"is_private": false,
"is_anonymous": false,
"body": "The conference room should require a key card. Security is not a game.",
"replies": [
{
"author_name": "Michael Scott",
"body": "Noted, Dwight. The key card stays in my office.",
"created_at": 1794830400
}
],
"created_at": 1794823200,
"updated_at": 1794823200
}
},
{
"type": "changelog_comment",
"id": "e1a7c3d9-4b52-4f86-9c0e-7d3a5f1b8e26",
"attributes": {
"author_name": "Anonymous",
"is_mine": false,
"is_private": false,
"is_anonymous": true,
"body": "Can we book it for the Dundies?",
"replies": [],
"created_at": 1794826800,
"updated_at": 1794826800
}
}
]
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.