Skip to content

Ramp: List comments on an object's discussion thread

Ramp comments.getCommentsResource: arguments, response, policy and SDK examples.

← Comments operations · Get started

Operation ramp.get_comments_resource

Provider route: GET /developer/v1/comments/{object_type}/{object_id}. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["comments"]["getCommentsResource"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.comments.getCommentsResource(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.comments.get_comments_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.object_idstringRequired within parent
path.object_typestringRequired within parentOne of: bills, draft-bills, spend-requests, transactions
queryobjectOptionalAdditional keys: not allowed
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List comments on an object’s discussion thread — response body

Referenced models: List comments on an object’s discussion thread — response body

List comments on an object's discussion thread — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Create a comment on an object's discussion thread — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: Create a comment on an object's discussion thread — response body, List bills — response body — page

Create a comment on an object's discussion thread — response body
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTime at which the comment was created in ISO 8601 format.
Format: date-time
idstringRequired within parentUnique identifier of the comment.
messagestringRequired within parentThe comment message content.
user_idstringRequired within parentUnique identifier of the user who created the comment.
Format: uuid
List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative

SDK function policy ID: ramp.get_comments_resource. Catalog operation: get_comments_resource. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.