Atlassian: Get comments by I Ds

Atlassian issueComments.getCommentsByIds: arguments, response, policy and SDK examples.

← Issue comments operations · Get started

Operation atlassian.getcommentsbyids

Provider route: POST /{cloudId}/rest/api/3/comment/list. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueComments"]["getCommentsByIds"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueComments.getCommentsByIds(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_comments.get_comments_by_ids(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional
`body`	Model	Required within parent	Expand Get comments by I Ds — request body — body

Referenced models: Get comments by I Ds — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get comments by I Ds — response body

Referenced models: Get comments by I Ds — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Get comments by I Ds — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`ids`	array	Required within parent	The list of comment IDs. A maximum of 1000 IDs can be specified. Unique items: true
`ids[]`	integer	Each item	Format: int64

Get comments by I Ds — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A page of items.
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Whether this is the last page. Read only: true
`isLast (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of items that could be returned. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the page. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of items returned. Format: int64 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	The list of items. Read only: true
`values (anyOf 1)[]`	Model	Each item	Expand Add comment — response body
`values (anyOf 2)`	null	Alternative

Referenced models: Add comment — response body

Add comment — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A comment. Additional keys: allowed
`author`	JSON	Optional
`author (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The ID of the user who created the comment. Read only: true
`author (anyOf 2)`	null	Alternative
`body`	JSON	Optional
`body (anyOf 1)`	JSON	Alternative	The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
`body (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The date and time at which the comment was created. Read only: true
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the comment. Read only: true
`id (anyOf 2)`	null	Alternative
`jsdAuthorCanSeeRequest`	JSON	Optional
`jsdAuthorCanSeeRequest (anyOf 1)`	boolean	Alternative	Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature. Read only: true
`jsdAuthorCanSeeRequest (anyOf 2)`	null	Alternative
`jsdPublic`	JSON	Optional
`jsdPublic (anyOf 1)`	boolean	Alternative	Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation. Read only: true
`jsdPublic (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	array	Alternative	A list of comment properties. Optional on create and update.
`properties (anyOf 1)[]`	Model	Each item	Expand Get user property — response body
`properties (anyOf 2)`	null	Alternative
`renderedBody`	JSON	Optional
`renderedBody (anyOf 1)`	string	Alternative	The rendered version of the comment. Read only: true
`renderedBody (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the comment. Read only: true
`self (anyOf 2)`	null	Alternative
`updateAuthor`	JSON	Optional
`updateAuthor (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The ID of the user who updated the comment last. Read only: true
`updateAuthor (anyOf 2)`	null	Alternative
`updated`	JSON	Optional
`updated (anyOf 1)`	JSON	Alternative
`updated (anyOf 1) (anyOf 1)`	string	Alternative	The date and time at which the comment was updated last. Read only: true
`updated (anyOf 1) (anyOf 2)`	integer	Alternative
`updated (anyOf 2)`	null	Alternative
`visibility`	JSON	Optional
`visibility (anyOf 1)`	Model	Alternative	Expand Add comment — response body — visibility The group or role to which this item is visible The group or role to which this comment is visible. Optional on create and update.
`visibility (anyOf 2)`	null	Alternative

Referenced models: Get user property — response body, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone, Add comment — response body — visibility The group or role to which this item is visible

Get user property — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the property. Required on create and update.
`key (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	JSON	Alternative	The value of the property. Required on create and update.
`value (anyOf 2)`	null	Alternative

Add comment — response body — visibility The group or role to which this item is visible

Field	Type	Presence	Description and constraints
`$`	object	Root	The group or role to which this item is visible. Additional keys: allowed
`identifier`	JSON	Optional
`identifier (anyOf 1)`	JSON	Alternative
`identifier (anyOf 1) (anyOf 1)`	string	Alternative	The ID of the group or the name of the role that visibility of this item is restricted to.
`identifier (anyOf 1) (anyOf 2)`	null	Alternative
`identifier (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	Whether visibility of this item is restricted to a group or role. Known values: group, role
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`.
`value (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getcommentsbyids. Catalog operation: getCommentsByIds. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source

Report an issue with this page