How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Issue Comments API

Manage comments on issues.

Jira Issue Comments API is one of 12 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Issue Comments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, rate-limit docs, and a changelog.

This API exposes 2 operations across 1 path, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 3.

Requests are made against a single base URL, https://{domain}.atlassian.net/rest/api/3.

2 operations 1 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3
Base URL
https://your-domain.atlassian.net/rest/api/3
Authentication
HTTP Basic, OAuth 2.0, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 3

Jira Issue Comments API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic authentication using an Atlassian account email and API token. Format: email:apitoken, Base64 encoded. Generate API tokens at https://id.atlassian.com/ma…
  • oauth2 — OAuth 2.0 authorization code grant (3LO) for Jira Cloud apps.
  • bearerAuth — Bearer token authentication using a personal access token (PAT) or OAuth 2.0 access token.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Issue Comments 2

Manage comments on issues.

GET
/issue/{issueIdOrKey}/comment
Jira Get Comments
getComments 5 params → 200401404
POST
/issue/{issueIdOrKey}/comment
Jira Add Comment
addComment 2 params body → 201400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Comment (10 properties), UserDetails (8 properties), PageOfComments (4 properties), AvatarUrls (4 properties). Each schema is shown below with its type and property counts.

UserDetails
object
A Jira user.
8 properties
AtlassianDocumentFormat
object
Atlassian Document Format (ADF) representation of rich text content. ADF is a JSON-based format used in Jira Cloud REST API v3 for description, comment, and ot…
3 properties 3 required
AvatarUrls
object
Avatar URLs in multiple sizes.
4 properties
PageOfComments
object
A paginated list of comments.
4 properties
Comment
object
A comment on an issue.
10 properties
ErrorCollection
object
Error details returned by the API.
3 properties
Visibility
object
The visibility restrictions for a comment.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-comments-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Issue Comments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.