> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sourcery.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sourcery API

The Sourcery API is a Team-plan REST API for security findings. It is the only public API; the GraphQL endpoint stays internal.

## What you can do

Endpoints live under `/api/v1/`. They cover two resources: individual security issues and the groups Sourcery clusters related issues into. The group detail endpoint embeds its member issues, so listing a group's issues is one request.

| Endpoint                                  | What it does                                    |
| ----------------------------------------- | ----------------------------------------------- |
| `GET /api/v1/security-issues`             | List issues, with filtering and pagination.     |
| `GET /api/v1/security-issues/{id}`        | Get one issue.                                  |
| `GET /api/v1/security-issues/stats`       | Aggregate counts by status and severity.        |
| `PATCH /api/v1/security-issues`           | Bulk-update status and severity override.       |
| `GET /api/v1/security-issue-groups`       | List groups, with filtering and pagination.     |
| `GET /api/v1/security-issue-groups/{id}`  | Get one group, with its member issues embedded. |
| `GET /api/v1/security-issue-groups/stats` | Aggregate counts by status and severity.        |
| `PATCH /api/v1/security-issue-groups`     | Bulk-update status and severity override.       |

The list endpoints filter by `repository_ids`, `issue_types`, `statuses`, and `search`, and paginate with a `cursor` and `limit`. The API has no rate limits today.

## The OpenAPI reference

The live reference, with every parameter and response shape, is at [api.sourcery.ai/api](https://api.sourcery.ai/api). It's always current because it's generated from the running service.

> The endpoints require security scanning, a Team-plan capability. Anyone with a seat on a GitHub-
>     or GitLab-connected account can create a key, but it only works against a Team-plan account.

## What's next