List project issues with the GitLab API
Lists the issues of a project, newest first. Each item has iid, the number of the issue in the project, which the issue tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Identifier
- gitlab_list_project_issues
The request
POST https://connect.reportei.com/api/tools/gitlab_list_project_issues/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The id of the project from List projects, or its path_with_namespace, such as group/project. |
| state | string | No | Only issues in this state. The default is all.Values: opened, closed, all |
| search | string | No | Text matched against the title and description. |
| labels | string | No | Comma-separated label names, such as bug,ui. Only issues with all of them. None for issues without labels, Any for issues with at least one. |
| milestone | string | No | Title of a milestone. None for issues without milestone, Any for issues with one. |
| author_username | string | No | Username of the author. |
| assignee_username | string | No | Username of an assignee. |
| created_after | string | No | Only issues created on or after this time. |
| updated_after | string | No | Only issues updated on or after this time. |
| order_by | string | No | Sort field. The default is created_at.Values: created_at, updated_at, due_date, priority, title |
| sort | string | No | Sort order. The default is desc.Values: asc, desc |
| per_page | integer | No | Results per page, up to 100. The default is 20. |
| page | integer | No | Page 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_project_issues. It becomes your agent's tool definition with no conversion.
Other GitLab tools
- List projectsGETLists projects, newest first. Send membership true to get only the projects of the account: without it, GitLab.com returns every public project. Each item has id and path_with_namespace, which the other tools take as the project. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- List project membersGETLists the members of a project, including those inherited from its groups. Each item has id, username and name: the id is what assignee_ids and reviewer_ids ask for. Paginate with page and per_page.
- List issuesGETLists issues of every project the account can see. By default only the issues the account created: send scope assigned_to_me or all for the others. Each item has project_id and iid, which the issue tools ask for. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get issueGETReturns an issue of a project, with title, description, state, labels, assignees, milestone and due date.
- Create issuePOSTCreates an issue in a project and returns it, with its iid. Notifies the participants.
- Update issuePUTChanges an issue and returns it. Only the fields sent change, and at least one must be sent. To close or reopen it, send state_event. labels replaces all the labels; add_labels and remove_labels change only the ones named.
- List issue notesGETLists 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.
- Create issue notePOSTAdds a comment (note) to an issue and returns it. Notifies the participants.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
