List issue notes with the GitLab API

Lists the comments (notes) of an issue, newest first by default, including the notes GitLab writes for each change. Send activity_filter only_comments to keep just what people wrote. Paginate with page and per_page.

Identifier
gitlab_list_issue_notes

The request

POST https://connect.reportei.com/api/tools/gitlab_list_issue_notes/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "issue_iid": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
idstringYesThe id of the project from List projects, or its path_with_namespace, such as group/project. In List issues it is the project_id of the issue.
issue_iidintegerYesThe iid of the issue from List project issues or List issues, not its id.
activity_filterstringNoWhich notes to return. The default is all_notes.Values: all_notes, only_comments, only_activity
order_bystringNoSort field. The default is created_at.Values: created_at, updated_at
sortstringNoSort order. The default is desc.Values: asc, desc
per_pageintegerNoResults per page, up to 100. The default is 20.
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their GitLab account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/gitlab, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/gitlab_list_issue_notes. It becomes your agent's tool definition with no conversion.

Other GitLab tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.